Metadata-Version: 2.1
Name: traviscli
Version: 0.3.2
Summary: A build help tool
Home-page: https://github.com/hasii2011/travisci-cli
Author-email: Humberto.A.Sanchez.II@gmail.com
Description-Content-Type: text/markdown
License-File: LICENSE

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI version](https://badge.fury.io/py/traviscli.svg)](https://badge.fury.io/py/traviscli)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
[![macOS](https://svgshare.com/i/ZjP.svg)](https://svgshare.com/i/ZjP.svg)

[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)

## Introduction
This is a simple CLI that allows you to update a version.txt file with a build number.
    
## Install traviscli in your virtual environment
This utility is distributed via [pypi](https://pypi.org/project/traviscli/) packages.

Install like this:
```commandline
pip3 install traviscli
```

## How to use

```commandline
traviscli --help
Usage: traviscli [OPTIONS]

  Use this command to get the Travis CI build number of your project.  Assumes
  you are using Semantic Versioning

Options:
  -b, --build-count INTEGER  Number builds to check.
  -r, --repo-slug TEXT       something thing like hasii2011/PyUt.  [required]
  -f, --file PATH            Relative location of version text file
  --major-version INTEGER    Change the major number to the specified one
  --minor-version INTEGER    Change the minor number to the specified one
  --patch-version INTEGER    Change the patch number to the specified one
  --version                  Show the version and exit.
  --help                     Show this message and exit.
```
## How to get your TravisCI Application Token
Go to your `TravisCI Profile-->Settings-->Settings` Tab

For example:

![image info](./images/TravisCI-ApplicationToken.png)

## Where to put configuration token 
Create a file named `.travis-cli.ini` in your home directory (or where `$HOME` points to)

## Configuration file format
```ini
[TRAVISCI]
travisci_api_token = Your Token goes here
```
## Version file format

The version string in your version file should follow the rules for [semantic versioning](https://semver.org)

For example, here is a correctly formatted version string

`6.2.1+.500`





