HOA utils
Utilities for the HOA format.
Install
The best way is to install the package from PyPI:
pip install hoa-utils
Alternatively, you can install it from source (master branch):
pip install git+https://github.com/whitemech/hoa-utils.git
What you'll find
- APIs to create and manipulate HOA objects
- CLI tools to about the HOA format.
The implementation may not be very stable at the moment.
Currently, the only supported CLI tool is:
pyhoafparser: parse and validate a file in HOA format.
Development
If you want to contribute, here's how to set up your development environment.
- Install Poetry
- Clone the repository:
git clone https://github.com/whitemech/hoa-utils.git && cd hoa-utils - Install the dependencies:
poetry install
Tests
To run tests: tox
To run only the code tests: tox -e py3.7
To run only the code style checks:
tox -e black-checktox -e isort-checktox -e flake8
In tox.ini you can find all the test environment supported.
Docs
To build the docs: mkdocs build
To view documentation in a browser: mkdocs serve
and then go to http://localhost:8000
Authors
License
hoa-utils is released under the MIT License.
Copyright 2020 WhiteMech
1 maintainer
Metadata
1 maintainer
Release files for hoa-utils 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| hoa_utils-0.1.0.tar.gz | 17.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hoa_utils-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 43.8 kB
Release files / hoa_utils-0.1.0.tar.gz
| Download URL | hoa_utils-0.1.0.tar.gz |
|---|---|
| Size | 17.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e2bf4ad9cbdb37b0d393259c39fe65935e72a9f269edb0040dfbe149f89dd0bc
|
|
BLAKE2b-256 checksum How to use checksums |
b66aaa1b530c3e92af6156b4b917a7eacc777077c653adc4f2ac9af82ed38e6d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.5
|
Release files / hoa_utils-0.1.0-py3-none-any.whl
| Download URL | hoa_utils-0.1.0-py3-none-any.whl |
|---|---|
| Size | 26.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eb08f74f75feae19be96ae7162127b548529077ffafcc199d424a7ef47abc09b
|
|
BLAKE2b-256 checksum How to use checksums |
651d6be9a14ac5c8d9a7e02b9af0b61ee4f2a0f409699cd06d1109e9a16dba1a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.5
|
Security for hoa-utils 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
