Metadata-Version: 2.1
Name: d3-cli
Version: 0.1.0
Summary: Utility scripts for ManySecured-D3 claims
Home-page: https://github.com/TechWorksHub/ManySecured-D3DB
Author: NquiringMinds
Author-email: contact@nquiringminds.com
Requires-Python: >=3.8,<4
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: PyYAML (>=6.0,<7.0)
Requires-Dist: ipython (>=8.4.0,<9.0.0)
Requires-Dist: iteration-utilities (>=0.11.0,<0.12.0)
Requires-Dist: jsonschema (>=4.4.0,<5.0.0)
Requires-Dist: matplotlib (>=3.5.2,<4.0.0)
Requires-Dist: networkx (>=2.8.3,<3.0.0)
Requires-Dist: pandas (>=1.4.2,<2.0.0)
Requires-Dist: requests (>=2.27.1,<3.0.0)
Requires-Dist: tqdm (>=4.64.0,<5.0.0)
Requires-Dist: yamllint (>=1.26.3,<2.0.0)
Project-URL: Repository, https://github.com/TechWorksHub/ManySecured-D3DB.git
Description-Content-Type: text/markdown

# ManySecured d3-scripts

Utility scripts for ManySecured-D3 claims

## Installation

These utility scripts require Python to use.

When developing these scripts, [Python Poetry](https://python-poetry.org/)
is used to install and manage dependencies, however,
in future, `poetry` will be used to publish these scripts in a format
that any Python package manager can understand (e.g. `pip`-compatable).

Poetry will create a python isolated virtual environment in the `./.venv` folder and install dependencies if you run:

```bash
poetry install
```

You cannot run scripts directly from the `./src/d3-scripts` since we are using [Python relative imports](https://realpython.com/absolute-vs-relative-python-imports/#relative-imports).

Instead, you must run a script defined in the `[tool.poetry.scripts]` field of [`pyproject.toml`](./pyproject.toml):

## Usage

D3 Linter

```console
alois@nqm-alois-entroware:~/Documents/ManySecured-D3DB/d3-scripts$ poetry run d3lint --help
usage: d3lint [-h] D3_FILE [D3_FILE ...]

Lint D3 files for YAML syntax errors

positional arguments:
  D3_FILE     Files to lint

options:
  -h, --help  show this help message and exit

Example: d3_lint.py *.d3
```

## Tests

Tests can be run via:

```bash
poetry run pytest
```

