https://github.com/chrispyles/fica

A Python library for managing and documenting user configurations
https://github.com/chrispyles/fica

configuration documentation python sphinx sphinx-extension

Last synced: 20 days ago
JSON representation

A Python library for managing and documenting user configurations

• Host: GitHub
• URL: https://github.com/chrispyles/fica
• Owner: chrispyles
• License: mit
• Created: 2022-03-19T07:30:41.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T05:30:02.000Z (2 months ago)
• Last Synced: 2024-10-11T19:12:09.227Z (about 1 month ago)
• Topics: configuration, documentation, python, sphinx, sphinx-extension
• Language: Python
• Homepage: https://fica.readthedocs.io
• Size: 229 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `fica` 

[![PyPI](https://img.shields.io/pypi/v/fica.svg)](https://pypi.org/project/fica/)

[![Run tests](https://github.com/chrispyles/fica/actions/workflows/run-tests.yml/badge.svg)](https://github.com/chrispyles/fica/actions/workflows/run-tests.yml)

[![codecov](https://codecov.io/gh/chrispyles/fica/branch/main/graph/badge.svg?token=67BKRAXF7T)](https://codecov.io/gh/chrispyles/fica)

[![Documentation Status](https://readthedocs.org/projects/fica/badge/?version=latest)](https://fica.readthedocs.io/en/latest/?badge=latest)



  



`fica` is a Python library for managing and documenting the structure of user-specified

configurations. With it, you can create dictionaries of configurations that contain default values

and descriptions for easily configuring applications with user input and documenting available

configurations and their defaults.

`fica` is compatible with Python 3.9+.

## Documentation

You can find the documentation for `fica` [here](https://fica.readthedocs.io/).

## Contributing

See [`CONTRIBUTING.md`](CONTRIBUTING.md).

## Changelog

See [`CHANGELOG.md`](CHANGELOG.md).