From a6ed74dfe50ee202bdf8649e78f65fa5458ec6e6 Mon Sep 17 00:00:00 2001 From: Benedith Mulongo Date: Fri, 11 Oct 2024 15:55:53 +0200 Subject: [PATCH] Update readme.md --- README.md | 31 ++++++++++++++++++++----------- norduniclient-package.md | 16 ++++++++++++---- 2 files changed, 32 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index ad5e82a..2df13a1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ # python-norduniclient -[![PyPI](https://img.shields.io/pypi/v/norduniclient.svg)](https://pypi.python.org/pypi/norduniclient) +[![PyPI](https://img.shields.io/pypi/v/norduniclient.svg)](https://pypi.python.org/pypi/norduniclient) Neo4j database client for NORDUnet network inventory -## Setup +## Compatibility + +| Tools | Version | +| ----------- | --------- | +| neo4j DB | 4.4.x | +| neo4j | 4.4.x | +| neomodel | 5.0.x | + +## Setup ``` poetry shell @@ -31,7 +39,6 @@ poetry run python -m unittest discover or save the environment variables in a local file `.env` and run it with [dotenvx](https://dotenvx.com/) as follows: - ```bash dotenvx run -- poetry run python -m unittest discover ``` @@ -46,18 +53,15 @@ nox -rs tests nox -rs tests_dotenv ``` - - ## Installation ```bash pip install norduniclient ``` +python3 -m pip install --index-url --extra-index-url 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 +python3 -m pip install -i --extra-index-url jolieprinter ## Usage @@ -69,7 +73,6 @@ NODE_META_TYPE_CHOICES = zip(nc.META_TYPES, nc.META_TYPES) print("nc.META_TYPES=", nc.META_TYPES) ``` - ### Poetry guide ``` @@ -79,29 +82,35 @@ poetry run python [operation] ### Add depenency #### Add a new lib + ```bash poetry add ``` + #### Remove a lib + ```bash poetry remove ``` - #### Get venv path + ```bash poetry run which python ``` #### Show dependencies + ```bash poetry show ``` + ```bash poetry run pip list ``` #### List configuratiom + ```bash poetry config --list ``` @@ -113,4 +122,4 @@ 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 -``` \ No newline at end of file +``` diff --git a/norduniclient-package.md b/norduniclient-package.md index 21dc494..637d516 100644 --- a/norduniclient-package.md +++ b/norduniclient-package.md @@ -1,12 +1,20 @@ # python-norduniclient -[![PyPI](https://img.shields.io/pypi/v/norduniclient.svg)](https://pypi.python.org/pypi/norduniclient) +[![PyPI](https://img.shields.io/pypi/v/norduniclient.svg)](https://pypi.python.org/pypi/norduniclient) Neo4j database client for NORDUnet network inventory -## Setup +## Compatibility -``` +| Tools | Version | +| ----------- | --------- | +| neo4j DB | 4.4.x | +| neo4j | 4.4.x | +| neomodel | 5.0.x | + +## Setup + +```bash poetry shell poetry install ``` @@ -23,7 +31,7 @@ NEO4J_USER=xx NEO4J_PASSWORD=xx ``` -``` +```bash poetry run python -m unittest discover ```