SigmaEpsilon.Core - Common developer utilities for Python projects#

The package contains some usefull stuff for general Python development activites that turned out to be highly reusable during developing projects in the SigmaEpsilon namespace.

Some of the most notable contents:

Metaprogramming
- A collection of meta and abstract base classes.
- A classproperty decorator.
- A solution to enforce abstract class properties on a class.
- Reusable facilities for project configuration, testing, exceptions, etc.
Wrapping
- An extendible Wrapper class and a few factory functions to help you safely wrap objects.

Documentation#

The documentation is built with Sphinx using the PyData Sphinx Theme and hosted on ReadTheDocs.

Installation#

Before attempting to install the package, it is suggested to upgrade pip:

python -m pip install --upgrade pip

sigmaepsilon.core can be installed (either in a virtual enviroment or globally) from PyPI using pip on Python >= 3.7:

>>> pip install sigmaepsilon.core

or chechkout with the following command using GitHub CLI

gh repo clone sigma-epsilon/sigmaepsilon.core

and install from source by typing

>>> pip install .

If you want to run the tests, you can install the package along with the necessary optional dependencies like this

>>> pip install ".[test]"

Development mode#

For development purposes, it is suggested to install the package in editable mode, with the optional dependencies for both testing, development and documentation

>>> pip install -e ".[test, dev, docs]"

Testing and coverage#

To run the tests, run the following command in the root of the project:

python -m pytest --cov-report html --cov-config=.coveragerc --cov sigmaepsilon.core

License#

This package is licensed under the MIT license. See the attached LICENSE file for the details.

Contents#

API Reference