norduniclient/README.md

126 lines
2 KiB
Markdown
Raw Permalink Normal View History

2024-10-10 14:37:08 +00:00
# python-norduniclient
2024-10-11 13:55:53 +00:00
[![PyPI](https://img.shields.io/pypi/v/norduniclient.svg)](https://pypi.python.org/pypi/norduniclient)
2024-10-10 14:37:08 +00:00
Neo4j database client for NORDUnet network inventory
2024-10-11 13:55:53 +00:00
## Compatibility
| Tools | Version |
| ----------- | --------- |
| neo4j DB | 4.4.x |
| neo4j | 4.4.x |
| neomodel | 5.0.x |
## Setup
2024-10-10 14:37:08 +00:00
```
poetry shell
poetry install
```
## Running tests
Add the following environment variables:
```env
NEO4J_HTTP_PORT=7474
NEO4J_BOLT_PORT=7687
NEO4J_HOSTNAME=xx
NEO4J_USER=xx
NEO4J_PASSWORD=xx
```
and run
```bash
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
```
or
```bash
nox -rs tests
```
```bash
nox -rs tests_dotenv
```
## Installation
```bash
pip install norduniclient
```
2024-10-11 13:55:53 +00:00
python3 -m pip install --index-url <https://platform.sunet.se/api/packages/benedith/pypi/simple/> --extra-index-url <https://pypi.org/simple/> norduniclient
2024-10-10 14:37:08 +00:00
2024-10-11 13:55:53 +00:00
python3 -m pip install -i <https://test.pypi.org/simple/> --extra-index-url <https://pypi.org/simple/> jolieprinter
2024-10-10 14:37:08 +00:00
## Usage
```python
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
2024-10-11 13:55:53 +00:00
2024-10-10 14:37:08 +00:00
```bash
poetry add <library>
```
2024-10-11 13:55:53 +00:00
2024-10-10 14:37:08 +00:00
#### Remove a lib
2024-10-11 13:55:53 +00:00
2024-10-10 14:37:08 +00:00
```bash
poetry remove <library>
```
#### Get venv path
2024-10-11 13:55:53 +00:00
2024-10-10 14:37:08 +00:00
```bash
poetry run which python
```
#### Show dependencies
2024-10-11 13:55:53 +00:00
2024-10-10 14:37:08 +00:00
```bash
poetry show
```
2024-10-18 12:29:18 +00:00
2024-10-10 14:37:08 +00:00
```bash
poetry run pip list
```
#### List configuratiom
2024-10-11 13:55:53 +00:00
2024-10-10 14:37:08 +00:00
```bash
poetry config --list
```
### Publish
```bash
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
2024-10-11 13:55:53 +00:00
```