norduniclient/README.md

python-norduniclient

Neo4j database client for NORDUnet network inventory

Compatibility

Tools	Version
neo4j DB	4.4.x
neo4j	4.4.x
neomodel	5.0.x

Setup

poetry shell
poetry install

Running tests

Add the following environment variables:

NEO4J_HTTP_PORT=7474
NEO4J_BOLT_PORT=7687
NEO4J_HOSTNAME=xx
NEO4J_USER=xx
NEO4J_PASSWORD=xx

and run

poetry run python -m unittest discover

or save the environment variables in a local file .env and run it with dotenvx as follows:

dotenvx run -- poetry run python -m unittest discover

or

nox -rs tests

nox -rs tests_dotenv

Installation

pip install norduniclient

python3 -m pip install --index-url https://platform.sunet.se/api/packages/benedith/pypi/simple/ --extra-index-url https://pypi.org/simple/ norduniclient

python3 -m pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ jolieprinter

Usage

import norduniclient as nc

NODE_META_TYPE_CHOICES = zip(nc.META_TYPES, nc.META_TYPES)

print("nc.META_TYPES=", nc.META_TYPES)

Poetry guide

poetry run python [operation]

Add depenency

Add a new lib

poetry add <library>

Remove a lib

poetry remove <library>

Get venv path

poetry run which python

Show dependencies

poetry show

poetry run pip list

List configuratiom

poetry config --list

Publish

poetry config repositories.pypi https://upload.pypi.org/legacy/
poetry config pypi-token.pypi [token]
poetry publish --build --repository pypi
poetry publish --build --repository testpypi