Setup project

Fork this repo and clone your forked repo

At first, fork this repo into your account. Then clone it into your local disk.

Install virtual environment

Because we want to keep a minimal list dependencies for this project, we recommend to create an virtual enviroment to maintain these dependencies. Virtual enviroment module has been integrated into standard library since Python 3.5. It is pretty easy to create an virtual environment. Execute following commands:

cd aquarium
python -m venv .venv

After installing an virtual environment, make sure to activate the virtual enviroment.

If you are use Windows, execute:

.venv/Scripts/activate

If you are using Linux or MacOS, execute:

source .venv/bin/activate

For more information, see official document

Install dependencies

requirements.txt keeps the list of dependencies, you can just run pip -r requirements.txt to install them. Make sure that the virtual environment created in the previous step is activated.