Spock is a framework designed to help manage complex parameter configurations for Python applications
Project description
Managing complex configurations any other way would be highly illogical...
About
spock
is a framework that helps manage complex parameter configurations during research and development of Python
applications. spock
let's you focus on the code you need to write instead of re-implementing boilerplate code like
creating ArgParsers, reading configuration files, implementing traceability etc.
In short, spock
configurations are defined by simple and familiar class-based structures. This allows spock
to
support inheritance, read from multiple markdown formats, and allow hierarchical configuration by composition.
Documentation
Current documentation and more information can be found here.
Quick Install
Supports Python 3.7+
pip install spock-config
Key Features
- Simple Declaration: Parameters are defined within a
@spock_config
decorated class. Supports types, required/optional, and automatic defaults. - Easily Managed Parameter Groups: Each class automatically generates its own object within a single namespace.
- Parameter Inheritance: Classes support inheritance allowing for complex configurations derived from a common base set of parameters.
- Multiple Configuration File Types: Configurations are specified from YAML, TOML, or JSON files.
- Hierarchical Configuration: composed from multiple configuration files via simple include statements.
- Immutable: All classes are frozen preventing any misuse or accidental overwrites.
- Tractability and Reproducibility: Save currently running parameter configuration with a single chained command.
Main Contributors
Nicholas Cilfone, Siddharth Narayanan
spock
is developed and maintained by the Artificial Intelligence Center of Excellence at Fidelity Investments.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for spock_config-1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67d14aa6c4028eed063c5e350d9701c052399cc1d4786b304cf7d4e70477efc6 |
|
MD5 | 6e13a14b0c873277016b813600ffaf46 |
|
BLAKE2b-256 | 17ba73515534cae810f23c4297189e7ef47dfd139d9bd2bce296a1f560ac7c99 |