[](https://travis-ci.org/cbmi/harvest) [](https://coveralls.io/r/cbmi/harvest) [](https://bitdeli.com/free "Bitdeli Badge")
## Install
```bash
$ pip install harvest
```
## Harvest CLI
### Dependencies
This version of Harvest requires Python 2.6 or 2.7.
### Start A New Project
```bash
$ harvest init [--verbose] [--no-env] [--no-input] project_name
```
This command performs the following steps:
- Create a new virtualenv environment (name `project_name`-env)
- Installs Django
- Creates a starter project using the built-in Harvest template
- Installs the base dependencies
- Syncs and migrates a SQLite database, this requires you to answer a couple
prompts (unless `--no-input` is passed)
- Collects the static CSS and JavaScript files (mainly due to Cilantro)
- Prints out a message to perform a couple commands in your shell
**Arguments**
`project_name` - The name of the project which must be a valid Python
identifier since it will be an importable Python package. This means it can
only contain alphanumeric characters and underscores and cannot start with a
number, such as `myproject`, `my_project`, and `project1`, but not `1project`,
`my-project` or `-myproject`.
**Options**
`--verbose` - Pass to get all output printed to stdout. Multiple flags can be
passed to increase the verbosity, e.g. `-vv`.
`--no-env` - Pass to prevent creating a virtualenv. If set, it is assumed the
virtualenv is active prior to running this command to ensure dependencies are
installed in the correct site-packages directory.
`--no-input` - Pass to prevent being prompted during the setup. This
currently includes the prompt for setting up a superuser during the database
sync. This is primarily useful for performing scripted builds.
`--template` - Specify a template to base your Harvest application on. By
default `harvest init` will base its build off of
`https://github.com/cbmi/harvest-template`. By passing a URL to this option
`harvest init` will attempt to bootstrap the project based on the endpoint
specified. Additionally, if your provided template contains a Fabric fabfile
containing a `harvest_bootstrap` task the init command will offload all
bootstrapping tasks beyond creating the virtualenv and installing of
dependencies to the `harvest_bootstrap` task. This could be useful in situations
where further assumptions can be made about a new Harvest deployment
(i.e. containerization, use of a specific DB, specific Django models, etc.).
`--venv-wrap` - If you are using virtualenvwrapper to handle your python virtual
environments you can set this flag to create a virtualenv in accordance with
the conventions of that utility -- The name of your environment will correspond
to your project name and will be created in the directory specified by the
`WORKON_HOME` environment variable.
**Post-Setup**
After creating a new Harvest project, the next step is to define a few Django
models. Run `python bin/manage.py avocado check` to see what needs to be
further setup as well as optional settings and dependencies that can be
installed.
### Update Harvest
This command updates itself to the lastest stable version from PyPi.
```bash
$ harvest update
```
### Install Demo
This command installs one of the Harvest demos.
```bash
$ harvest init-demo [--verbose] [--no-env] demo_name
```
**Arguments**
`demo_name` - The name of an available demo which is currently only `openmrs`.
**Options**
`--verbose` - Pass to get all output printed to stdout. Multiple flags can be
passed to increase the verbosity, e.g. `-vv`.
`--no-env` - Pass to prevent creating a virtualenv. If set, it is assumed the
virtualenv is active prior to running this command to ensure dependencies are
installed in the correct site-packages directory.
Metadata
Release files for harvest 2.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| harvest-2.2.3.tar.gz | 9.3 kB | Without provenance | Details for harvest-2.2.3.tar.gz |
Release files / harvest-2.2.3.tar.gz
| Download URL | harvest-2.2.3.tar.gz |
|---|---|
| Size | 9.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dc7c5416d7391d076d9085f4a094dc4088989a6bfa1635014f8833856c60ea1b
|
|
BLAKE2b-256 checksum How to use checksums |
1c0700e710178cd2b18a9b694fd6e1cdb1b5f71fdc1ff64264454a3ffe636afe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for harvest 2.2.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.