This release is a pre-release and may not be stable for production use.
Boxine - bx_py_utils
Various Python / Django utility functions
Quickstart
pip install bx_py_utils
Existing stuff
Here only a simple list about existing utilities. Please take a look into the sources and tests for deeper informations.
models utilities
approve_workflow- Base model/admin/form classes to implement a model with draft/approve versions workflowmanipulate.create_or_update()- Similar to django'screate_or_update()with benefitstimetracking.TimetrackingBaseModel()- Base model with "create" and "last update" date time
data types
data_types.gtin- ModelField, FormField and validators for GTIN/UPC/EAN numbers, more info: data_types/gtin/README.md
test utilities
datetime.MockDatetimeGenerator()- Mock djangotimezone.now()with generic time stampsdatetime.parse_dt()- Handydatetime.strptime()converthtml_assertion.HtmlAssertionMixin- Unittest mixin class with usefull assertments around Django test client testsmodel_clean_assert.CleanMock()- Context manager to track if modelfull_clean()was calledusers- Utilities around user/permission setup for teststime.MockTimeMonotonicGenerator()- Mocktime.monotonic()with generic time stamps
performance analysis
dbperf.query_recorder.SQLQueryRecorder- Context Manager that records SQL queries executed via the Django ORM
humanize
humanize.time.human_timedelta()- Converts a time duration into a friendly text representation. (X ms,sec,minutesetc.)templatetags.humanize_time.human_duration()- Verbose time since template tag, e.g.:<span title="Jan. 1, 2000, noon">2.0 seconds</span>filename.filename2human_name()- Convert filename to a capitalized namefilename.clean_filename()- Convert filename to ASCII only via slugify
misc
dict_utils.dict_get()- nested dictget()dict_utils.pluck()- Extract values from a dict, if they are presenterror_handling.print_exc_plus()- Print traceback information with a listing of all the local variables in each framestacktrace.get_stacktrace()- Returns a filterable and easy-to-process stacktrace
developing
To start developing e.g.:
~$ git clone https://github.com/boxine/bx_py_utils.git
~$ cd bx_py_utils
~/bx_py_utils$ make
help List all commands
install-poetry install or update poetry
install install via poetry
update Update the dependencies as according to the pyproject.toml file
lint Run code formatters and linter
fix-code-style Fix code formatting
tox-listenvs List all tox test environments
tox Run pytest via tox with all environments
tox-py36 Run pytest via tox with *python v3.6*
tox-py37 Run pytest via tox with *python v3.7*
tox-py38 Run pytest via tox with *python v3.8*
tox-py39 Run pytest via tox with *python v3.9*
pytest Run pytest
pytest-ci Run pytest with CI settings
publish Release new version to PyPi
makemessages Make and compile locales message files
start-dev-server Start Django dev. server with the test project
clean Remove created files from the test project (e.g.: SQlite, static files)
You can start the test project with the Django developing server, e.g.:
~/bx_py_utils$ make start-dev-server
This is a own manage command, that will create migrations files from our test app, migrate, collectstatic and create a super user if no user exists ;)
If you like to start from stretch, just delete related test project files with:
~/bx_py_utils$ make clean
...and start the test server again ;)
License
MIT. Patches welcome!
Links
7 maintainers
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bx_py_utils-16rc2.tar.gz.
File metadata
- Download URL: bx_py_utils-16rc2.tar.gz
- Upload date:
- Size: 25.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3e279479bbf2dc956dcdf60a4a5f4fc457d58145f42967bd10d2507560320d05
|
|
| MD5 |
94a41cc4f3d4919e238ce4bfdc396f8d
|
|
| BLAKE2b-256 |
4acb94ba3366e0fe0cdf07a92c2b1c965b337401c3544dee3a099a33a0871df2
|
File details
Details for the file bx_py_utils-16rc2-py3-none-any.whl.
File metadata
- Download URL: bx_py_utils-16rc2-py3-none-any.whl
- Upload date:
- Size: 34.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
42f4fd699fe0d987575a7e9bd928721f6c82655b89a83b2f6178f36d1e1f5dab
|
|
| MD5 |
4e0c0d240f7c395d4327213a54d70b17
|
|
| BLAKE2b-256 |
428929f2bc6841efda291b02e6ad7aad5694ff440ec6489165160168696082f3
|
