Object tracking and metrics
Project description
sparrow-tracky
Object tracking and metrics
Poetry
Want to know more about Poetry? Check its documentation.
Details about Poetry
Poetry's commands are very intuitive and easy to learn, like:
poetry add numpy@latest
poetry run pytest
poetry publish --build
etc
Building and releasing your package
Building a new version of the application contains steps:
- Bump the version of your package
poetry version <version>
. You can pass the new version explicitly, or a rule such asmajor
,minor
, orpatch
. For more details, refer to the Semantic Versions standard. - Make a commit to
GitHub
. - Create a
GitHub release
. - And... publish 🙂
poetry publish --build
Installation
pip install -U sparrow-tracky
or install with Poetry
poetry add sparrow-tracky
Makefile usage
Makefile
contains a lot of functions for faster development.
1. Download and remove Poetry
To download and install Poetry run:
make poetry-download
To uninstall
make poetry-remove
2. Install all dependencies and pre-commit hooks
Install requirements:
make install
Pre-commit hooks coulb be installed after git init
via
make pre-commit-install
3. Codestyle
Automatic formatting uses pyupgrade
, isort
and black
.
make codestyle
# or use synonym
make formatting
Codestyle checks only, without rewriting files:
make check-codestyle
Note:
check-codestyle
usesisort
,black
anddarglint
library
Update all dev libraries to the latest version using one comand
make update-dev-deps
4. Code security
make check-safety
This command launches Poetry
integrity checks as well as identifies security issues with Safety
and Bandit
.
make check-safety
5. Type checks
Run mypy
static type checker
make mypy
6. Tests with coverage badges
Run pytest
make test
7. All linters
Of course there is a command to rule run all linters in one:
make lint
the same as:
make test && make check-codestyle && make mypy && make check-safety
8. Docker
make docker-build
which is equivalent to:
make docker-build VERSION=latest
Remove docker image with
make docker-remove
More information about docker.
9. Cleanup
Delete pycache files
make pycache-remove
Remove package build
make build-remove
Delete .DS_STORE files
make dsstore-remove
Remove .mypycache
make mypycache-remove
Or to remove all above run:
make cleanup
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 sparrow-tracky-0.3.5.dev1655851886.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | da5f50cb92984f1b2b14d29f97623834f9d5c71eb66bce3034a42512989f8742 |
|
MD5 | 11c1599e808d6a3ea47a70b594a7bc91 |
|
BLAKE2b-256 | f89e44ffadee242cb0c7d126370ca7bc6ff354d22563ad8559b6c3ed72d3a0ad |
Hashes for sparrow_tracky-0.3.5.dev1655851886-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be82fe319529975752e2753e31aebf8265f460a8e4790eac1daa9d02710330f0 |
|
MD5 | 5640d995a0a02803f8b9ea30b1f49df9 |
|
BLAKE2b-256 | 80f689985af7b7a8e2dd0a6535679bde9876027fc13b020d37444ac562541865 |