Contributions are encouraged and welcome!! Please use the issue page to submit feature requests or bug reports. Issues with attached PRs will be given priority and have a much higher likelihood of acceptance. Please also open an issue and associate it with any submitted PRs.
We are actively seeking additional maintainers. If you're interested, please contact me.
django-render-static uses Poetry for environment, package and
dependency management. Poetry greatly simplifies environment
bootstrapping. Once it's installed.
poetry install -E allSome of the tests require npm to be installed.
django-render-static documentation is generated using
Sphinx with the readthedocs
theme. Any new feature PRs must provide updated documentation for the features added. To build
the docs run:
cd ./doc
poetry run doc8 --ignore-path build --max-line-length 100
poetry run make htmldjango-render-static uses Pylint for Python linting and
mypy for type checking. Header imports are also standardized using
isort. Before any PR is accepted the following must be run, and
static analysis tools should not produce any errors or warnings. Disabling certain errors or
warnings where justified is acceptable:
./check.sh
poetry run python -m readme_renderer ./README.mddjango-render-static is setup to use
django-pytest to allow
pytest to run Django unit tests. All the tests are housed in
tests/tests.py. Before a PR is accepted, all tests must be passing and the code
coverage must be at 100%.
To run the full suite:
poetry run pytestTo run a single test, or group of tests in a class:
poetry run pytest <path_to_tests_file>::ClassName::FunctionNameFor instance to run all tests in DefinesToJavascriptTest, and then just the test_classes_to_js test you would do:
poetry run pytest tests/tests.py::DefinesToJavascriptTest
poetry run pytest tests/tests.py::DefinesToJavascriptTest::test_classes_to_js