Boxine - bx_py_utils

Various Python 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.

test utilities

datetime.parse_dt() - Handy datetime.strptime() convert
assert_json_requests_mock() - Check the requests history of requests_mock.mock()
assert_equal() - Compare objects with a nice diff using pformat
assert_text_equal() - Compare text strings with a nice diff
assert_snapshot - Helper for quick snapshot test functionality (comparing value with one stored in a file using json)
assert_text_snapshot - Same as assert_snapshot comparing text strings
assert_py_snapshot - Snapshot test using PrettyPrinter()

humanize

humanize.time.human_timedelta() - Converts a time duration into a friendly text representation. (X ms, sec, minutes etc.)
pformat() - Better pretty-print-format using JSON with fallback to pprint.pformat()

AWS stuff

bx_py_utils.aws.secret_manager.SecretsManager - Get values from AWS Secrets Manager
bx_py_utils.test_utils.mock_aws_secret_manager.SecretsManagerMock - Mock our SecretsManager() helper in tests
bx_py_utils.test_utils.mock_boto3session.MockedBoto3Session - Mock boto3.session.Session() (Currently only get_secret_value())
bx_py_utils.aws.client_side_cert_manager.ClientSideCertManager - Helper to manage client-side TLS certificate via AWS Secrets Manager

GraphQL

graphql_introspection.introspection_query Generate an introspection query to get an introspection doc.
graphql_introspection.complete_query Generate a full query for all fields from an introspection doc.

misc

dict_utils.dict_get() - nested dict get()
dict_utils.pluck() - Extract values from a dict, if they are present
environ.cgroup_memory_usage() - Get the memory usage of the current cgroup
error_handling.print_exc_plus() - Print traceback information with a listing of all the local variables in each frame
iteration.chunk_iterable() - Create chunks off of any iterable
processify.processify() - Will execute the decorated function in a separate process
anonymize.anonymize() - Anonymize a string (With special handling of email addresses)
hash_utils.url_safe_hash() - Generate URL safe hashes
compat.removeprefix() - Backport of str.removeprefix from PEP-616
compat.removesuffix() - Backport of str.removesuffix from PEP-616

Backwards-incompatible changes

v36 -> v37 - Outsourcing Django stuff

We split bx_py_utils and moved all Django related utilities into the separated project:

https://github.com/boxine/bx_django_utils

So, bx_py_utils is better usable in non-Django projects, because Django will not installed as decency of "bx_py_utils"

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
clean                Remove created files from the test project

License

MIT. Patches welcome!

Metadata

Release files for bx-py-utils 37rc1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bx-py-utils 37rc1
File	Size	Uploaded
bx_py_utils-37rc1.tar.gz	15.1 kB	May 21, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for bx-py-utils 37rc1
File	Interpreter	ABI	Platform	Reset
bx_py_utils-37rc1-py3-none-any.whl 18.0 kB May 21, 2021	Python 3	none	any	Details

Total release size: 33.1 kB

Release files / bx_py_utils-37rc1.tar.gz

Download URL	bx_py_utils-37rc1.tar.gz
Size	15.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`8d8d2e7df55fc54fc7e7537da425fdafa82e76f2153787d0d30da4080218eb8f`
BLAKE2b-256 checksum How to use checksums	`1a342eeda8649c58a1ed17a04c4c218834fd118a039ca273f03bc647dcdafa60`
Upload date	May 21, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.5`

Release files / bx_py_utils-37rc1-py3-none-any.whl

Download URL	bx_py_utils-37rc1-py3-none-any.whl
Size	18.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`9e31a8691308c2ff7202f7dd9e0b664e005a4e2d34b8ecd9ed0d35b291def89e`
BLAKE2b-256 checksum How to use checksums	`57276b1b51178929b71ef013fa0439deb6778702a907b738962ade4554c2266f`
Upload date	May 21, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.5`