❗ NOTE: This is an example from the INTERSECT training "Packaging" course
Package
package is a simple Python library that contains a single function for rescaling arrays.
Installation
Download the source code and use the package manager pip to install package:
pip install .Usage
import numpy as np
from package.rescale import rescale
# rescales over 0 to 1
rescale(np.linspace(0, 100, 5))Docs using Dockerfile
Build:
docker build -t intersect-training-packaging .
Run:
docker run -p 8080:80 intersect-training-packaging
Go to http://localhost:8080 for Sphinx Docs
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
TBD