Skip to content

Latest commit

 

History

History
84 lines (63 loc) · 4.15 KB

File metadata and controls

84 lines (63 loc) · 4.15 KB


RiCS: My personal Python toolbox.

PyPI - Version PyPI - Python Version Tests Codecov Read the Docs PyPI - License

What is it?

An assorted collection of reusable functions that used to live in a Dropbox folder. RiCS, pronounced "rix", is short for Richard's Code Stash. I started this project with the purpose of learning more about Python best practices, typing and the Python ecosystem.

It has grown organically since then, and now provides a wide variety of small utility functions. Large submodules are typically converted to stand-alone PyPI packages once they begin to mature.

Highlighted Features

Related libraries

The following packages started life as RiCS submodules.

  • ID Translation PyPI - Version Read the Docs Cookiecutter template

    Turn meaningless IDs into human-readable labels.

  • Time Split PyPI - Version Read the Docs Docker Image Size (tag)

    Time-based k-fold validation splits for heterogeneous data.

Installation

The package is published through the Python Package Index (PyPI). Source code is available on GitHub: https://github.com/rsundqvist/rics

pip install -U rics

This is the preferred method to install rics, as it will always install the most recent stable release.

License

MIT

Documentation

Hosted on Read the Docs: https://rics.readthedocs.io

Command line program

The rics CLI is bundled with the package. Some related libraries will add new subroutines. To get an overview, run:

rics --help

in the terminal.

Contributing

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. To get started, see the Contributing Guide and Code of Conduct.