Skip to main content
Help improve PyPI by participating in a 5-minute user interface survey!

Deploy your applications on VM Farms.

Project Description

# Farmer

[![Build Status](https://travis-ci.org/vmfarms/farmer.svg?branch=master)](https://travis-ci.org/vmfarms/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
```

You can also set the token using the `FARMER_TOKEN` environment variable:

```
FARMER_TOKEN=c422b5e2230d617d22759a19a5a5cb65792edebc farmer apps
```

## 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
```

### `farmer logdna`

Export logs from [LogDNA](https://logdna.com/) in [JSONLines format](http://jsonlines.org/).

First, generate a [service key](https://app.logdna.com/manage/profile) and configure Farmer:

```
farmer logdna config
```

To export logs, run `farmer logdna export`.
You can filter results by application, host, log level, or a custom search query.

```
# Export all PostgreSQL logs from the past week.
farmer logdna export --from 'last week' --app postgres

# Export deploy logs from today.
farmer logdna export --app deploy
```

The `-f`/`--from` and `-t`/`--to` options support human readable dates like "1 hour ago", "30 minutes ago", "yesterday", etc.
Refer to the [dateparser documentation](https://dateparser.readthedocs.io/en/latest/) for more information.

## Getting help

To get help for a specific command or subcommand, run `farmer help`:

```
farmer help deploy
```

```
farmer help logdna config
```

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


Release history Release notifications

This version
History Node

2.4.0

History Node

2.3.0

History Node

2.2.0

History Node

2.1.1

History Node

2.1.0

History Node

2.0.1

History Node

2.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
farmer-2.4.0-py2.py3-none-any.whl (17.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Mar 12, 2018
farmer-2.4.0.tar.gz (11.2 kB) Copy SHA256 hash SHA256 Source None Mar 12, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page