benedith/norduniclient
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Update readme.md
Some checks are pending
Python CI / test (push) Waiting to run
Details

Browse source
This commit is contained in:
Benedith Mulongo 2024-10-11 15:55:53 +02:00
parent 615835d57d
commit a6ed74dfe5
Signed by: benedith
GPG key ID: 62D68B584B4B3EB3
2 changed files with 32 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,9 +1,17 @@
# python-norduniclient
[![PyPI](https://img.shields.io/pypi/v/norduniclient.svg)](https://pypi.python.org/pypi/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
```
@ -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 <https://platform.sunet.se/api/packages/benedith/pypi/simple/> --extra-index-url <https://pypi.org/simple/> 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 <https://test.pypi.org/simple/> --extra-index-url <https://pypi.org/simple/> 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 <library>
```
#### Remove a lib
```bash
poetry remove <library>
```
#### Get venv path
```bash
poetry run which python
```
#### Show dependencies
```bash
poetry show
```
```bash
poetry run pip list
```
#### List configuratiom
```bash
poetry config --list
```

14
norduniclient-package.md
View file

@ -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
## 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
```