Skip to content

Install Neptune#

You're viewing docs for Neptune 2.x

The documentation on this site is for the following Neptune versions:

For the new docs, visit docs.neptune.ai →

Prerequisites#

Software Version Website
Python 3.8+ python.org/downloads
pip - pip.pypa.io

Installation#

To install the Neptune client library, open a terminal and enter the following command:

pip install neptune
Where to enter the command
  • Linux: Command line
  • macOS: Terminal app
  • Windows: PowerShell or Command Prompt
  • Jupyter Notebook: In a cell, prefixed with an exclamation mark: ! your-command-here
Upgrading with neptune-client already installed

Important: To smoothly upgrade to the 1.0 version of the Neptune client library, first uninstall the neptune-client library and then install neptune.

Step 1
pip uninstall neptune-client
Step 2
pip install neptune

Additional setup#

Make sure to save your Neptune credentials as environment variables.

Need more help with getting started?

The Neptune tutorial walks you through the complete setup process and all the Neptune essentials.

Installing from GitHub#

You can install with pip from GitHub:

pip install git+https://github.com/neptune-ai/neptune-client.git

You can also clone the neptune-client repository and then install with:

pip install .

Installing from conda#

Neptune is not supported on conda.

Some Neptune packages are available on the conda-forge channel, but they're not actively maintained and may not work properly.