Skip to content

Latest commit

 

History

History
56 lines (33 loc) · 1.9 KB

README.rst

File metadata and controls

56 lines (33 loc) · 1.9 KB

django-nh3

actions pypi black pre-commit

Django integration with for nh3, Python binding to Ammonia HTML sanitizer Rust crate.

nh3 docs

Requirements

Python 3.10 to 3.12 supported.

Django 3.2 to 5.0 supported.

Contributing

The project is in it's infancy, setup because of bleach becoming deprecated.

It is setup with pre-commit to maintain code quality. This includes black for formatting, ruff for linting & checks. This is much like django, so currently referring to django's own style docs will be most helpful

To contribute, fork the repo and clone your fork to your machine. Then setup a virtual environment however you prefer to do this. Then run the following setup the basics:

python -m pip install pre-commit tox
pre-commit install

Tox is used to run tests locally and on github. The test requirements are generated using pip-tools via requirements/compile.py.