Utilities for the HOA format.
Project description
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-check
tox -e isort-check
tox -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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hoa_utils-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb08f74f75feae19be96ae7162127b548529077ffafcc199d424a7ef47abc09b |
|
MD5 | 6044398c62d31877c8d11b1485cd12e4 |
|
BLAKE2b-256 | 651d6be9a14ac5c8d9a7e02b9af0b61ee4f2a0f409699cd06d1109e9a16dba1a |