Skip to content

Installation

Terminal window
pip install nx_neptune

For Jupyter notebook support:

Terminal window
pip install "nx_neptune[jupyter]"
Terminal window
git clone git@github.com:awslabs/nx-neptune.git
cd nx-neptune
make install
Terminal window
# Package the project from source:
python -m pip wheel -w dist .
# Install from wheel:
pip install "dist/nx_neptune-0.6.0-py3-none-any.whl"

Dependencies are pinned in lock files (requirements.txt, requirements-dev.txt, requirements-jupyter.txt) generated by pip-tools. If you update pyproject.toml, regenerate them with:

Terminal window
make lock

make lock must be run with a Python 3.11 interpreter to match CI. If your default Python is a different version:

Terminal window
python3.11 -m venv .venv-lock
source .venv-lock/bin/activate
pip install pip-tools
make lock