A Python package for data structures
Project description
sparrow-datums
A Python package for data structures
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-datums
or install with Poetry
poetry add sparrow-datums
Then you can run
sparrow-datums --help
or with Poetry
:
poetry run sparrow-datums --help
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-datums-0.8.1.dev1655842168.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2eb039f2fc0975fe7c7411943601c50064dc17d4872a5d206132bd9b3ef71e9d |
|
MD5 | e90a45aac7f2b454b7426f0182822796 |
|
BLAKE2b-256 | 2b654b52e3ddcead6404a34aaa2d82fa76086e1cf1241d08112e49129c8808bf |
Hashes for sparrow_datums-0.8.1.dev1655842168-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7b6c4fbfd7662aad0778d93c314c5af1c82a9cd6672ea4f29200cbe68115dc0 |
|
MD5 | 068d7f4b56b65727d8ababa251f00d86 |
|
BLAKE2b-256 | ba0e7fd1003ae559e31393a926dd2a0dd1f3e408a2d1b27224beb7ffe8f954f4 |