Building Apyfal

Installing Apyfal build environment

Prepare Python environment

Ensure that pip, setuptools and wheel are installed and up to date.

pip install --upgrade setuptools pip wheel

Clone repository from Github

Apyfal development version is hosted on github, to get it use git clone:

git clone https://github.com/Accelize/apyfal.git

Installing all Apyfal requirements

To install all package that are required to run Apyfal, run the following line in repository directory:

pip install -e .[all]

Running tests

To run unittest, run the following line in repository directory:

./setup.py test

Generating documentation

To generate Sphinx documentation, run the following line in repository directory:

./setup.py build_sphinx

To see generated documentation open /build/sphinx/html/index.html with browser.

Generating wheel package

To generate wheel package, run the following line in repository directory:

./setup.py bdist_wheel

Generated wheel can be found in /dist.