toolbox-python
Introduction
The purpose of this package is to provide some helper files/functions/classes for generic Python processes.
Key URLs
For reference, these URL's are used:
| Type | Source | URL |
|---|---|---|
| Git Repo | GitHub | https://github.com/data-science-extensions/toolbox-python |
| Python Package | PyPI | https://pypi.org/project/toolbox-python |
| Package Docs | Pages | https://data-science-extensions.com/python-toolbox/ |
Installation
You can install and use this package multiple ways by using pip, uv, pipenv, or poetry.
Using pip:
-
In your terminal, run:
python3 -m pip install --upgrade pip python3 -m pip install toolbox-python
-
Or, in your
requirements.txtfile, add:toolbox-python
Then run:
python3 -m pip install --upgrade pip python3 -m pip install --requirement=requirements.txt
Using uv:
-
In your terminal, run:
uv add toolbox-python
Using pipenv:
-
Install using environment variables:
In your
Pipfilefile, add:[[source]] url = "https://pypi.org/simple" verify_ssl = false name = "pypi" [packages] toolbox-python = "*"
Then run:
python3 -m pip install pipenv python3 -m pipenv install --verbose --skip-lock --categories=root index=pypi toolbox-python
-
Or, in your
requirements.txtfile, add:toolbox-python
Then run:
python3 -m run pipenv install --verbose --skip-lock --requirements=requirements.txt
-
Or just run this:
python3 -m pipenv install --verbose --skip-lock toolbox-python
Using poetry:
-
In your
pyproject.tomlfile, add:[tool.poetry.dependencies] toolbox-python = "*"
Then run:
poetry install -
Or just run this:
poetry add toolbox-python poetry install poetry sync
Contribution
Contribution is always welcome.
-
Clone your forked/branched repo.
-
Build your environment:
-
Start contributing.
-
When you're happy with the changes, raise a Pull Request to merge with the main branch again.
Build and Test
To ensure that the package is working as expected, please ensure that:
- You write your code as per PEP8 requirements.
- You write a UnitTest for each function/feature you include.
- The CodeCoverage is 100%.
- All UnitTests are passing.
- Type Checking is passing 100%.
- Complexity is within the required standard.
- Docstrings are correctly formatted.
Testing
-
Run them all together:
uv run src/utils/scripts.py check
-
Or run them individually:
-
uv run src/utils/scripts.py check-black
-
uv run src/utils/scripts.py check-pytest
-
uv run src/utils/scripts.py check-ty
-
uv run src/utils/scripts.py check-complexity
-
uv run src/utils/scripts.py check-docstrings
-
Release files for toolbox-python 1.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| toolbox_python-1.6.0.tar.gz | 31.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| toolbox_python-1.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:69.0 kB
Release files / toolbox_python-1.6.0.tar.gz
| Download URL | toolbox_python-1.6.0.tar.gz |
|---|---|
| Size | 31.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a248d56411f5e9d7efcd962db32fe9738501da067012c8ed399381906b085e11
|
|
BLAKE2b-256 checksum How to use checksums |
afcd9ab2a74df63a1e4573d4b9480f61ff1b4d732d869f19f3ff43dc979bb785
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / toolbox_python-1.6.0-py3-none-any.whl
| Download URL | toolbox_python-1.6.0-py3-none-any.whl |
|---|---|
| Size | 37.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
25e50e223f168a54d639937fbaf494c7b55e50fd69759428580f9e300dd15891
|
|
BLAKE2b-256 checksum How to use checksums |
82c263b66c42bd1399aa7f359c9572d1f149fb333b2df0c48a103349d0b52184
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|