Get started
Installation
DAN is based on a GitLab package registry containing all the nerval source code.
You need a personal access token with scope read_api
in order to install this module. You will need to add the below to your ~/.netrc
file:
machine gitlab.teklia.com
login __token__
password <YOUR_PERSONAL_TOKEN>
If you install DAN as a dependency, the host must have access to this configuration file to be able to download the nerval repository package.
As a dependency
To install DAN as a dependency, you need to first add the following line to your requirements.txt
file:
--index-url https://gitlab.teklia.com/api/v4/projects/98/packages/pypi/simple --extra-index-url https://gitlab.teklia.com/api/v4/projects/210/packages/pypi/simple
teklia-dan
The --index-url
argument is required to find the DAN
package, the --extra-index-url
argument is needed to find the nerval
dependency.
Then you can install it via pip:
pip install -r requirements.txt
Directly
To install DAN directly, you can install it via pip:
pip install --index-url https://gitlab.teklia.com/api/v4/projects/98/packages/pypi/simple --extra-index-url https://gitlab.teklia.com/api/v4/projects/210/packages/pypi/simple teklia-dan
The --index-url
argument is required to find the DAN
package, the --extra-index-url
argument is needed to find the nerval
dependency.
To learn more about the newly installed teklia-dan
command, make sure to run:
teklia-dan --help
As an editable package
For development and tests purpose it may be useful to install the project as a editable package with pip.
To install DAN as an editable package, you can install it via pip:
pip install --index-url https://gitlab.teklia.com/api/v4/projects/210/packages/pypi/simple -e .
The --index-url
argument is required to find the nerval
dependency.
Get started with: