Digital Marketplace utils
What's in here?
- Digital Marketplace API clients
- Formatting utilities for Digital Marketplace
- Digital Marketplace logging for Flask using JSON Logging
- Utility functions/libraries for Amazon S3, Mailchimp, Notify, Cloudwatch
- Helper code for Flask configuration
- A formed version of Flask Feature Flags
Logging from applications
When logging from applications you should write your message as a format
string and pass any required
arguments to the log method in the extra named argument. This allows our logging to use them as
separate fields in our JSON logs making it much easier to search and aggregate on them.
logger.info("the user {user_id} did the thing '{thing}'", extra={
'user_id': user_id, 'thing': thing
})
Note that apart from not getting the benefit, passing the formatted message can be dangerous. User
generated content may be passed, unescaped to the .format method.
Versioning
Releases of this project follow semantic versioning, ie
Given a version number MAJOR.MINOR.PATCH, increment the:
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards-compatible manner, and
- PATCH version when you make backwards-compatible bug fixes.
To make a new version:
- update the version in the
dmutils/__init__.pyfile - if you are making a major change, also update the change log;
When the pull request is merged a GitHub Action will tag the new version.
Pre-commit hooks
This project has a pre-commit hook to do some general file checks and check the pyproject.toml.
Follow the Quick start to see how to set this up in your local checkout of this project.
Licence
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.
The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.
1 maintainer
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 ccs_digitalmarketplace_utils-81.0.2.tar.gz.
File metadata
- Download URL: ccs_digitalmarketplace_utils-81.0.2.tar.gz
- Upload date:
- Size: 85.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f3a8079e7420cb3a82b607a7b4a0ad3f350ec76613614670d53902385c6a8bbd
|
|
| MD5 |
fc7f8e8ea31200cb9b2f1336bf0df5ab
|
|
| BLAKE2b-256 |
7e99caeeab850bf2f2d07eed18c28a1dcb314341adce33f84a7c806dcaa4e0e9
|
File details
Details for the file ccs_digitalmarketplace_utils-81.0.2-py3-none-any.whl.
File metadata
- Download URL: ccs_digitalmarketplace_utils-81.0.2-py3-none-any.whl
- Upload date:
- Size: 103.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8c85d4f2dc1c622b9fe712355bcdab5278613cd8d44adfbb2418826665b39a11
|
|
| MD5 |
52556c8c6d179503662716a3e587fe7b
|
|
| BLAKE2b-256 |
ec3f10b3dd896ac80f1a50432fcbca953e5c7f4bbe1650a25625e19cfdc38323
|
