Additional information for developers

Installation method for developers

Installation can be done from a precompiled wheel or from the sources. Clone the repository of discopygal (or use a ZIP of it) and enter it:

git clone https://bitbucket.org/taucgl/discopygal.git
cd dicsopygal

Automatically with pip

Install with pip like any other local package:

In the root dir of discopygal repo run:

pip install .

If you are changing the files of the repo you probably want to install in dev mode to make the changes you make in the repo files be updated automatically to the package. Therefore the installation line should instead be:

pip install -e .

Automatically with Pipenv

After pipenv is installed:

Install the virtual environment:

pipenv install
To use a specific Python version use the command:
pipenv install --python <path_to_python_executable>

For purposes of developing the repo, like building docs or packages, install with the command:

pipenv install --dev

To activate environment to run discopygal run:

pipenv shell

Installing manually

Install CGALPY
Can be done simply with the command:
pip install git+https://bitbucket.org/taucgl/cgal-python-bindings/src/master/
(The full installation guide can be found here: https://bitbucket.org/taucgl/cgal-python-bindings/src/master/)
Install additional packages using pip according to received errors

Build (and install) the whl file, run the following in cmd/bash:

pip install build
python ./scripts/build_package.py
pip install dist/discopygal-taucgl-<version>-py3-none-any.whl

You can make sure that the code works correctly by running the unit tests:

python -m unittest