A set of utilities for Python projects
Project description
py-toolbox
py-toolbox
is a set of utilities for Python projects
Requirements
The toolbox has been written in Python 3
, and it needs version 3.7
.
The dependencies are managed by pip
using the file requirements.txt
.
Installation
To add py-toolbox
to your project, run the following command. This will add the last released version to you project:
pip install --upgrade cerbernetix.toolbox
For getting the last unstable version, the package needs to be installed from the source code. The following command will grab the last develop version:
pip install --upgrade git+https://github.com/cerbernetix/py-toolbox.git@develop
If you prefer using ssh:
pip install --upgrade git+ssh://git@github.com/cerbernetix/py-toolbox.git@develop
Usage
py-toolbox
offers several utilities per domain.
Please refer to the documentation for more information.
Development
Check out the repository:
git clone git@github.com:cerbernetix/py-toolbox.git
Then, create the virtual env and install the dependencies:
cd py-toolbox
python3 -m venv ".venv"
source "./venv/bin/activate"
pip install -r requirements.txt
pip install -e .
Note: For deactivating the virtual env, call the command deactivate
.
Automating the environment activation/deactivation
For activating the virtual env automatically when entering the project folder, and deactivating it when leaving the folder, you can add this snippet to you shell profile:
cd() {
builtin cd "$@"
local venv=".venv"
# If a Python virtualenv is active, deactivate it if the new folder is outside
if [[ -v VIRTUAL_ENV ]] ; then
local parent=$(dirname "${VIRTUAL_ENV}")
if [[ "${PWD}"/ != "${parent}"/* ]] ; then
deactivate
fi
fi
# If a Python env folder is found then activate the virtualenv
if [[ -d "./${venv}" ]] ; then
# Is it a Python venv?
if [[ -f "./${venv}/bin/activate" ]] ; then
source "./${venv}/bin/activate"
fi
fi
}
Code style
Code is linted using PyLint and formatted using Black. The docstrings are validated using pydocstyle.
Testing
Each module comes with unit tests, by convention, a test
folder must be added to each package
Unit tests are made using unittest
. To run them:
python3 -m unittest
Document
Docstrings are written following the Google docstrings format.
The documentation is generated using lazydocs.
The script ./pydoc.sh
can be used to regenerate it.
License
Copyright (c) 2023 Jean-Sébastien CONAN Distributed under the MIT License (See LICENSE file or copy at http://opensource.org/licenses/MIT).
Project details
Release history Release notifications | RSS feed
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
Hashes for cerbernetix.toolbox-0.9.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01dec73dd8859a8911f24fefa7f083e4cc37be3766c9b826e0043ffd33b1f83d |
|
MD5 | 91a024dc798dbdcc7d6e4f8bac09f8f2 |
|
BLAKE2b-256 | eb262f7ac269099620edf02a50dfb7c17972dc5ba2c8509d26107d58e41f6fc9 |
Hashes for cerbernetix.toolbox-0.9.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ebea81502f47ffcaceff7297e757f15f736e2a9e788a1b7f74c0800e060059b3 |
|
MD5 | 72b40572a4fc0a70a3dbb200a5b58b5b |
|
BLAKE2b-256 | ec26a1d6f2004d1f3bf788eca4a958e4caec8d64b9b6f7e14aa5df3baa9c2513 |