Installation

From PyPi

Using pip:

pip install recipipe

From source code

The latest code is in the master branch of the GitHub repository (https://github.com/guiferviz/recipipe). Clone the repository and change the current directory to the root directory of the project:

git clone git@github.com:guiferviz/recipipe.git
cd recipipe

As always, consider installing the package in a virtual environment. Install recipipe using pip:

pip install .

All the dependencies will be installed automatically.

If you are developing you need to install some extra dependencies (for running tests and generating docs):

pip install -r requirements_dev.in

Installing the recipipe package is not really needed for running tests.

If you are developing, it’s recommended to install it using the -e/--editable mode (i.e. setuptools “develop mode”):

pip install -e .

If you have any problems with the dependencies you can always use the exacts versions of the packages that are know to work well. Those dependencies are in requirements.txt and requirements_dev.txt for production and development dependencies respectively. Install them using:

pip install -r <requirements-filename>

Test the installation

Execute the recipipe.greet method to test that everything is working properly:

python -c "import recipipe; recipipe.greet()"

You should see something similar to a joke on the screen and the version of the program.