DKUtils
Description
The DKUtils python package was written to provide utility functions and classes that are used in DataKitchen recipes. It serves two main purposes.
- Provide a Python API Client for interacting with the DataKitchen platform’s REST API (DataKitchenClient)
- Provide utility classes and methods for interacting with tools commonly orchestrated in recipes in the DataKitchen platform (Alteryx, Jira, Gmail, etc.)
Development Info
Building and testing this module is conveniently done using Make. Issue the make command to see a list
of available targets (shown below for convenience). Note that any target can be suffixed with -ext to
run that target inside a Docker container. This allows testing and development in a standard and portable
environment. To develop inside a running docker container, use the bash-ext target. This will drop the
user into a bash shell inside a running container.
Add '-ext' to any target to run it inside a docker container
Versioning:
bump/major bump/minor bump/patch - bump the version
Utilities:
bash run bash - typically used in conjunction with -ext to enter a docker container
scan_secrets scan source code for sensitive information
Linting:
lint run flake8 and yapf
flake8 run flake8
yapf run yapf and correct issues in-place
yapf-diff run yapf and display diff between existing code and resolution if in-place is used
Testing:
test run all unit tests
test_unit run all unit tests
clean_unit remove files from last test run (e.g. report_dir, .coverage, etc.)
tox run unit tests in python 2 and 3
clean_tox clean tox files (e.g. .tox)
Documentation:
docs generate Sphinx documentation
docs/html generate Sphinx documentation
docs/clean remove generated Sphinx documentation
Build and Upload:
build generate distribution archives (i.e. *.tar.gz and *.whl)
upload upload distribution archives to PyPI
clean_build remove all the build files (i.e. build, dist, *.egg-info)
Cleanup:
clean run all the clean targets in one go
clean_pyc remove all *.pyc files
Pre-commit is also included to validate and flag commits that contain code
that does not pass Flake8 and YAPF.
To use, first install the python package pip install pre-commit and then run pre-commit install. All
future commits will run these tools and deny commits that don't pass. When running YAPF, pre-commit will
make in-place corrections to your code. Therefore, if it fails the YAPF validation on the first commit
attempt, simply review the changed files, add, and commit again to resolve.
1 maintainer
Metadata
1 maintainer
Release files for DKUtils 2.11.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| DKUtils-2.11.6.tar.gz | 50.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| DKUtils-2.11.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 121.0 kB
Release files / DKUtils-2.11.6.tar.gz
| Download URL | DKUtils-2.11.6.tar.gz |
|---|---|
| Size | 50.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
80b786487f872335062299d26b9413b213c9697a788ec8c37177c6149008a522
|
|
BLAKE2b-256 checksum How to use checksums |
9a09e989ef84ec6454522b415a766a6a9f1c5eb7283e085dc36299f21a2a54c5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.9.6 requests/2.28.2 setuptools/46.1.3 requests-toolbelt/0.10.1 tqdm/4.65.0 CPython/3.8.10
|
Release files / DKUtils-2.11.6-py3-none-any.whl
| Download URL | DKUtils-2.11.6-py3-none-any.whl |
|---|---|
| Size | 70.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
920f4b00c860676cc4da0880777f0909735c7ccb2563f1aad1059431ba85fcd1
|
|
BLAKE2b-256 checksum How to use checksums |
1c9d65969c6233c07da8c3e0cde92e838c428fbc17a1b02519a0e2ddf7f0ee5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.9.6 requests/2.28.2 setuptools/46.1.3 requests-toolbelt/0.10.1 tqdm/4.65.0 CPython/3.8.10
|
Security for DKUtils 2.11.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
