pyshared 1.2.0

A Python library containing common utility functions for use across multiple codebases, filling gaps not covered by the standard Python libraries.

PyShared: A Python Utility Library

PyShared is a personal Python utility library that I use in my projects containing a collection of consts/functions/classes/etc that I have found useful across multiple codebases.

Installation

pip install pyshared

for the lib, for the dev dependencies:

pip install pyshared[dev]

consts.py

• ALPHANUMERIC_CHARS: Import this constant for a string of all alphanumeric characters.
• ALPHANUMERIC_EXT_CHARS: Import this for an extended set of alphanumeric characters including underscores and hyphens.

from pyshared.consts import ALPHANUMERIC_CHARS, ALPHANUMERIC_EXT_CHARS

crypto.py

• is_jwt: Import this function to check if a given string is a valid JSON Web Token (JWT).

env.py

• typed_evar: Import this function to fetch environment variables with automatic type casting based on a provided default value.

exceptions.py

• NotPrintableError: Import this custom exception class for use in scenarios where object representations fail.

python.py

• ranstr: Import this function to generate random strings.
• safe_repr: Import this for a safe string representation of objects.
• default_repr: Import this for a default string representation of custom Python objects.
• truncstr: Import this for a truncated representation of the provided string.

shell.py

• runcmd: Import this function to execute shell commands from within Python.

terminal.py

• get_terminal_width: Import this to get the current width of the terminal.
• print_middle: Import this for printing text centered in the terminal.
• print_columns: Import this to neatly print items in columns according to the terminal width.

These specific imports are designed to provide direct access to the functionalities within the PyShared package, aligning with my approach to efficient and reusable coding.

Test Coverage

LITERALLY 100% LOL

Test Results:

---------- coverage: platform darwin, python 3.9.18-final-0 ----------
Name                     Stmts   Miss  Cover   Missing
------------------------------------------------------
pyshared/__init__.py         7      0   100%
pyshared/consts.py           3      0   100%
pyshared/crypto.py          21      0   100%
pyshared/env.py             26      0   100%
pyshared/exceptions.py       7      0   100%
pyshared/python.py          38      0   100%
pyshared/shell.py            9      0   100%
pyshared/terminal.py        34      0   100%
------------------------------------------------------
TOTAL                      145      0   100%

This comprehensive testing ensures that the library is reliable for production use.

License

MIT