Metadata-Version: 2.0
Name: farmer
Version: 2.2.0
Summary: Deploy your applications on VM Farms.
Home-page: https://github.com/vmfarms/farmer/
Author: VM Farms Inc.
Author-email: support@vmfarms.com
License: Apache 2.0
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: click (==6.6)
Requires-Dist: layeredconfig (==0.3.2)
Requires-Dist: requests (==2.11.1)
Requires-Dist: ruamel.yaml (==0.13.7)
Requires-Dist: six (==1.10.0)
Requires-Dist: stevedore (==1.2.0)

# Farmer

Use `farmer` to deploy your applications on [VM Farms](https://vmfarms.com/).

## Installation

Install with pip:

```
pip install farmer
```

## Configuration

You need to provide Farmer with your VM Farms API token. You can retrieve your API token from the [API documentation section](https://my.vmfarms.com/api/) of the VM Farms portal.

Run `farmer config` to set your token for the first time:

```
farmer config
```

If you need to change your token for any reason, you can use `farmer config set token`:

```
farmer config set token c422b5e2230d617d22759a19a5a5cb65792edebc
```

## Usage

### `farmer apps`

Run `farmer apps` to list your  applications.

```
farmer apps
```

If you don't see any applications, we probably need to connect a few wires for you. Contact our [support team](mailto:support@vmfarms.com) and we'll sort you out.

### `farmer deploy`

Run `farmer deploy` to deploy an application:

```
farmer deploy api api-prod
```

## Getting help

For bugs or feature requests related to Farmer itself, please open a [GitHub issue](https://github.com/vmfarms/farmer/issues/new).

For issues related to your applications or deploys, please contact [VM Farms support](mailto:support@vmfarms.com).

## Tricks

Add this snippet to your Bash configuration (`~/.bashrc` or `~/.bash_profile`) to enable tab-completion:

```shell
eval "$(_FARMER_COMPLETE=source farmer)"
```

Enjoy!

## License

Apache 2.0


