Additional information for developers

Installation method for developers

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 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

  1. 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/)

  2. Install additional packages using pip according to received errors

  3. 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