fpaupier / piecewise-functions

Piecewise constant functions

Piecewise functions

A library exposing a class for working with piecewise constant function.

Contributing

1. Create a virtual environment and activate it

python3 -m venv .venv
source .venv/bin/activate

2.Install the dependencies

pip install -r requirements.txt

3. Use the black formatting for your contribution

4. Your local dev environment is setup!

Running the tests

With your virtual environment setup, from the project root directory run pytest

Building & pushing the library

# 1. Use hatch to package the library
./build_lib.sh

# 2. Push to your favorite PyPy repo with:
#   (see TestPyPi doc https://packaging.python.org/en/latest/tutorials/packaging-projects/) 
python3 -m twine upload --repository testpypi dist/*

# 3. In your client project, install the desired version by running
pip install -i https://test.pypi.org/simple/ --no-deps piecewise-functions-fp==0.0.6

Bibliography

• Piecewise constant function see the Wolfram Mathworld post on the subject
• Heaviside Step function introduction at this post and Wikipedia

piecewise-functions's Issues

CI for running test on push on master

Add a CI to run the unit tests whenever a push on master is done or when a PR is to be merged on master

Add support for piecewise linear function