indieweb-utils is a Python library that provides building blocks for people implementing IndieWeb applications. This library contains implementations for some specifications that may be useful in IndieWeb applications.
This project is under active development.
The documentation for this project is available at indieweb-utils.readthedocs.io.
This project is licensed under the MIT license.
This project uses the following dependencies:
- BeautifulSoup4 for HTML parsing
- mf2py for microformats parsing
- requests for making HTTP requests
Quality is maintained ensuring each merged passes testing, typing, linting, and formatting requirements.
To check locally install the development dependencies and run the suite using tox.
$ pip install -r requirements_dev.txt $ tox
Alternatively, you can run just a single check by passing the environment to tox.
Tests use pytest.
$ tox -e py39 # Run all tests $ tox -e py39 tests/test_indieweb_utils.py::TestPostTypeDiscovery # Run a single test
Linting is checked with black, isort, and flake8.
$ tox -e lint
Black and isort errors can be fixed automatically. Use the fmt to fix those errors automatically.
$ tox -e fmt
Types are validated with mypy.
$ tox -e typecheck
This project welcomes contributions from anyone who wants to improve the library.
This library would benefit from the addition of new helper functions that would assist someone building an IndieWeb application. Assistance with documentation, building test cases, and fixing any bugs listed on the Issues page is also welcome.
If you have another idea on how to improve this library, let us know.
Feel free to create an issue or pull request on GitHub and your contribution will be reviewed.