Utilities for Legion Reporters and Monitors
Project description
Legion Utils
Utilities for Legion Reporters and Monitors
Usage
TODO
Installation & Setup
To install legion-utils with pip
execute the following:
pip install /path/to/repo/legion-utils
If you don't want to re-install every time there is an update, and prefer to just pull from the git repository, then use the -e
flag.
Development
Standards
- Be excellent to each other
- Code coverage must be at 100% for all new code, or a good reason must be provided for why a given bit of code is not covered.
- Example of an acceptable reason: "There is a bug in the code coverage tool and it says its missing this, but its not".
- Example of unacceptable reason: "This is just exception handling, its too annoying to cover it".
- The code must pass the following analytics tools. Similar exceptions are allowable as in rule 2.
pylint --disable=C0111,W1203,R0903 --max-line-length=100 ...
flake8 --max-line-length=100 ...
mypy --ignore-missing-imports --follow-imports=skip --strict-optional ...
- All incoming information from users, clients, and configurations should be validated.
- All internal arguments passing should be typechecked whenever possible with
typeguard.typechecked
Development Setup
Using poetry install from inside the repo directory:
poetry install
This will set up a virtualenv which you can always activate with either poetry shell
or run specific commands with poetry run
. All instructions below that are meant to be run in the virtualenv will be prefaced with (legion-utils)$
IDE Setup
Sublime Text 3
curl -sSL https://gitlab.com/-/snippets/2066312/raw/master/poetry.sublime-project.py | poetry run python
Testing
All testing should be done with pytest
which is installed with the dev
requirements.
To run all the unit tests, execute the following from the repo directory:
(legion-utils)$ pytest
This should produce a coverage report in /path/to/dewey-api/htmlcov/
While developing, you can use watchexec
to monitor the file system for changes and re-run the tests:
(legion-utils)$ watchexec -r -e py,yaml pytest
To run a specific test file:
pytest tests/unit/test_core.py
To run a specific test:
pytest tests/unit/test_core.py::test_hello
For more information on testing, see the pytest.ini
file as well as the documentation.
Project details
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
Hashes for legion_utils-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86f28d9fea279b06d97737054d0119a7e9f00d64f3d18dc0c2505a57a93e9c80 |
|
MD5 | 79b8888715e10168913fdd1609bdaa98 |
|
BLAKE2b-256 | 84b80f788ec71952a0eceb06dd1b247d08a111d8a1edc4e97e2982509bddca5b |