You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Contributions are encouraged! 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. That said, the aim is to keep this library as lightweight as possible. Only features with broad-based use cases will be considered.
16
4
17
-
We are actively seeking additional maintainers. If you're interested, please [contact me](https://github.com/bckohan).
5
+
We are actively seeking additional maintainers. If you're interested, please open an issue or [contact me](https://github.com/bckohan).
18
6
19
7
## Installation
20
8
@@ -26,7 +14,7 @@ poetry install
26
14
27
15
## Documentation
28
16
29
-
`django-typer` documentation is generated using [Sphinx](https://www.sphinx-doc.org/en/master/) with the [readthedocs](https://readthedocs.org/) theme. Any new feature PRs must provide updated documentation for the features added. To build the docs run doc8 to check for formatting issues then run Sphinx:
17
+
`django-typer` documentation is generated using [Sphinx](https://www.sphinx-doc.org) with the [furo](https://github.com/pradyunsg/furo) theme. Any new feature PRs must provide updated documentation for the features added. To build the docs run doc8 to check for formatting issues then run Sphinx:
30
18
31
19
```bash
32
20
cd ./doc
@@ -50,7 +38,7 @@ To run static analysis without automated fixing you can run:
50
38
51
39
## Running Tests
52
40
53
-
`django-typer` is set up to use [pytest](https://docs.pytest.org/en/stable/) to run 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%. A small number of exempted error handling branches are acceptable.
41
+
`django-typer` is set up to use [pytest](https://docs.pytest.org) to run unit tests. All the tests are housed in `tests`. Before a PR is accepted, all tests must be passing and the code coverage must be at 100%. A small number of exempted error handling branches are acceptable.
54
42
55
43
To run the full suite:
56
44
@@ -67,6 +55,6 @@ poetry run pytest <path_to_tests_file>::ClassName::FunctionName
67
55
For instance, to run all tests in BasicTests, and then just the test_call_command test you would do:
68
56
69
57
```shell
70
-
poetry run pytest tests/tests.py::BasicTests
71
-
poetry run pytest tests/tests.py::BasicTests::test_call_command
58
+
poetry run pytest tests/test_basics.py::BasicTests
59
+
poetry run pytest tests/test_basics.py::BasicTests::test_call_command
0 commit comments