Awesome `django-query-capture` is a Python cli/package created with https://github.com/TezRomacH/python-package-template
Project description
django-query-capture
Installation
pip install -U django-query-capture
or install with Poetry
poetry add django-query-capture
🛡 License
This project is licensed under the terms of the MIT
license. See LICENSE for more details.
Very first steps
Initialize your code
- Initialize
git
inside your repo:
cd django-query-capture && git init
- If you don't have
Poetry
installed run:
make poetry-download
- Initialize poetry and install
pre-commit
hooks:
make install
make pre-commit-install
- Run the codestyle:
make codestyle
Poetry
Want to know more about Poetry? Check its documentation.
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
📃 Citation
@misc{django-query-capture,
author = {AsheKR},
title = {Awesome `django-query-capture` is a Python cli/package created with https://github.com/TezRomacH/python-package-template},
year = {2022},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/ashekr/django-query-capture}}
}
Credits
This project was generated with python-package-template
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 django-query-capture-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fdf43e5b0927ed03d99e352a3a5f059fff79c34079684e4836760eb82287e6db |
|
MD5 | 156402075481d87691ce71f71c6ddcd7 |
|
BLAKE2b-256 | 9cde62b1a115940185b450f713cd20979655be198cf3cf62e46f6724a4ee3c92 |
Hashes for django_query_capture-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0832cf7167d27255498dbb5bc206bf3d2695aa9a834583999ea6a3373a8c170f |
|
MD5 | ae6691756dc25c87a3d7049f950954c5 |
|
BLAKE2b-256 | c6b10507d71c06517629d95be0b6a2a77ff7c55d960702e48ed5cab3f16f5bef |