Abotimable

Setup

This project relies on Python 3. pipenv is used to manage Python dependencies. If you do not have an adequate version of Python installed, it is recommended that you use pyenv.

Pipenv

All commands in this section should be run in the root directory of this project

First, make sure that pip3 is installed.

Next, install pipenv.

python3 -m pip install --user pipenv

The rest of the requirements are managed with pipenv.

python3 -m pipenv sync

You can now enter the created virtual environment.

python3 -m pipenv shell

Main

All commands in this section should be run in the root directory of this project

Once you are inside of the pipenv virtual environment, you can proceed.

python -m abotimable

Docker

To build the docker image, run the following.

docker build -t abotimable:latest .

Once the above is complete, run the following to start the server in your terminal.

docker run -tip 5000:5000 abotimable

Testing

Tests are located in the tests directory.

Once you are inside of the pipenv virtual environment, you can proceed.

# run all tests
python -m tests

Contributing

In general, this project follows guidelines set forward by PEP8 and The Hitchhiker's Guide to Python.

For Git, we will be following the Git Workflow set forth by Vincent Driessen on NVIE.

For docstrings, we will be using reStructuredText, as specified by PEP287 and used by Sphinx.