A slightly updated fork of `hoa_utils`. Utilities for the HOA format.
Project description
Disclaimer
This repository is a fork of hoa-utils (https://github.com/whitemech/hoa-utils).
I sincerely hope the (limited) changes I suggest are merged upstream. In case this
happens, I will archive the repository/PyPI package and redirect users towards the
upstream repo.
Original README.md
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
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hoa_utils_redux-0.2.0.tar.gz.
File metadata
- Download URL: hoa_utils_redux-0.2.0.tar.gz
- Upload date:
- Size: 246.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f1383b03b290340c7042b3b4150620e0bcc6c9f991362c931db8d8110db6f1ee
|
|
| MD5 |
81c178e270c91b4490d60f7f968dd589
|
|
| BLAKE2b-256 |
8e44f6c570305a145e10fc877a115d3c447047be3b6735b966cc7013974f2841
|
File details
Details for the file hoa_utils_redux-0.2.0-py3-none-any.whl.
File metadata
- Download URL: hoa_utils_redux-0.2.0-py3-none-any.whl
- Upload date:
- Size: 26.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8a82fa5524006861da828c53d04be1aa3082d79102389d404844cc9ad33d0087
|
|
| MD5 |
454bf70e462b0198b0d67f28287797f5
|
|
| BLAKE2b-256 |
3ac9b6210bc202c9d37a724528d06582adce7dfdf1f9a3ae82c71c0ad2fdba27
|
