Repository files navigation

Utilities for the HOA format.

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

• 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.

If you want to contribute, here's how to set up your development environment.

• InstallPoetry
• Clone the repository:git clone https://github.com/whitemech/hoa-utils.git && cd hoa-utils
• Install the dependencies:poetry install

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

Intox.ini you can find all the test environment supported.

To build the docs:mkdocs build

To view documentation in a browser:mkdocs serveand then go tohttp://localhost:8000

• Marco Favorito
• Francesco Fuggitti

hoa-utils is released under the MIT License.

Copyright 2020 WhiteMech