Welcome to the “Rudiments” manual!¶
Rudiments is a Python library that offers ‘miscellaneous’ functionality which
is unspecific in nature and shared among many projects. It also collects small
extensions to other support packages that don’t warrant their own project,
in the rudiments.reamed
package.
Important Links¶
Installing¶
Rudiments can be installed from PyPI via pip install rudiments
as
usual, see releases
on GitHub for an overview of available versions – the project uses
semantic versioning and follows
PEP 440 conventions.
To get a bleeding-edge version from source, use these commands:
repo="jhermann/rudiments"
pip install -r "https://raw.githubusercontent.com/$repo/master/requirements.txt"
pip install -UI -e "git+https://github.com/$repo.git#egg=${repo#*/}"
See the following section on how to create a full development environment.
Contributing¶
To create a working directory for this project, call these commands:
git clone "https://github.com/jhermann/rudiments.git"
cd "rudiments"
. .env --yes --develop
invoke build --docs test check
Contributing to this project is easy, and reporting an issue or adding to the documentation also improves things for every user. You don’t need to be a developer to contribute. See Contribution Guidelines for more.