Python package that group a lot of classes and functions that help software development.
Project description
Python Gemstones
Python package that group a lot of classes and functions that help software development.
Requirements
- Python 3.7+
How To Use
To use in your project, install pygemstones
module:
python3 -m pip install pygemstones
or:
poetry add pygemstones
And before call any pygemstones module, import system boostrap and call init
method:
from pygemstones.system import bootstrap
bootstrap.init()
Modules
There are several implemented modules for you to use:
- io.file
- io.net
- io.pack
- system.bootstrap
- system.platform
- system.runner
- system.settings
- type.list
- type.string
- util.log
- vendor.aws
Development
These are the requirements for local development:
- Python 3.7+
- Poetry (https://python-poetry.org/)
You can install locally:
poetry install
Or can build and generate a package:
poetry build
Tests
poetry run pytest
Coverage Tests
poetry run pytest --cov=pygemstones --cov-report=html tests
Note: see coverage report in htmlcov/index.html
Linters
To run all linters use:
poetry run black --check pygemstones/
poetry run black --check tests/
poetry run mypy --ignore-missing-imports pygemstones/
poetry run mypy --ignore-missing-imports tests/
Build and Publish
To build the package use:
poetry build
Set the token from your PyPI account with:
poetry config pypi-token.pypi [PyPI-Api-Access-Token]
And publish with:
poetry publish --build
Release
To create a release for Github Action publish steps
create a tag and push. Example:
git tag v0.0.1
git push origin v0.0.1
After release action finish, publish the release on Github releases
page and Github Action will run publish steps
automatically.
Buy me a coffee
License
Copyright (c) 2021-2024, Paulo Coutinho
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 pygemstones-0.0.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fac8418d74cbd5ee1b976f6c0959e71d6882aedbd3adcf52e2905b0f405ad66a |
|
MD5 | d91dbd63edede38bdc84af2f1c101bd9 |
|
BLAKE2b-256 | d20bdc1c248c787e306f6d96a326ac1e717b51be2666501b0356db8947190321 |