Overview🔗
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
, 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.txt
file, add:toolbox-python
Then run:
python3 -m pip install --upgrade pip python3 -m pip install --requirement=requirements.txt
Using pipenv
:🔗
-
Install using environment variables:
In your
Pipfile
file, 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.txt
file, 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.toml
file, 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:
-
With
pipenv
on Windows:if (-not (Test-Path .venv)) {mkdir .venv} python -m pipenv install --requirements requirements.txt --requirements requirements-dev.txt --skip-lock python -m poetry run pre-commit install python -m poetry shell
-
With
pipenv
on Linux:mkdir .venv python3 -m pipenv install --requirements requirements.txt --requirements requirements-dev.txt --skip-lock python3 -m poetry run pre-commit install python3 -m poetry shell
-
With
poetry
on Windows:python -m pip install --upgrade pip python -m pip install poetry python -m poetry init python -m poetry add $(cat requirements/root.txt) python -m poetry add --group=dev $(cat requirements/dev.txt) python -m poetry add --group=test $(cat requirements/test.txt) python -m poetry add --group=docs $(cat requirements/docs.txt) python -m poetry install python -m poetry run pre-commit install python -m poetry shell
-
With
poetry
on Linux:python3 -m pip install --upgrade pip python3 -m pip install poetry python3 -m poetry init python3 -m poetry add $(cat requirements/root.txt) python3 -m poetry add --group=dev $(cat requirements/dev.txt) python3 -m poetry add --group=test $(cat requirements/test.txt) python3 -m poetry add --group=docs $(cat requirements/docs.txt) python3 -m poetry install python3 -m poetry run pre-commit install python3 -m poetry shell
-
-
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.
- MyPy is passing 100%.