UpsilonConf documentation

UpsilonConf is a simple configuration library written in Python. Its main goal is to provide a convenient interface to work with configuration-like objects. A few handy tools to help with IO are also included.

• Getting Started
  • Installation
  • Quickstart
• API Reference
  • Configuration Objects
  • I/O Utilities
• Fun Facts
  • Origins
  • Design Principles
  • Related Libraries

Some Features

UpsilonConf is supposed to be a simple library in terms of code and usability. Nevertheless, the configuration objects in UpsilonConf come with some useful features:

• dict with attribute access

• object with indexing

• tuple of string for hierarchical indexing

• .-separated strings for hierarchical indexing

• flattening of hierarchical configs with .-separated strings as keys

• properly hashable frozen configuration type

• minimal (i.e. no) requirements for installation

• readily available conda package

• …

Furthermore, the included I/O tools should enable:

• reading/writing various file formats

• reading configuration directories

• retrieving configs from the command line

If you think a particular feature is missing or something is not working as expected, feel free to let me know by creating an issue.

Indices and tables

• Index

• Search Page