Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeremyagray/elective


https://github.com/jeremyagray/elective

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
.. *****************************************************************************

..

.. elective:  a Python configuration loader generator

..

.. Copyright 2021-2022 Jeremy A Gray .

..

.. SPDX-License-Identifier: MIT

..

.. *****************************************************************************



elective

--------



A `Python`_ configuration loader generator.



.. image:: https://badge.fury.io/py/elective.svg

   :target: https://badge.fury.io/py/elective

   :alt: PyPI Version

.. image:: https://readthedocs.org/projects/elective/badge/?version=latest

   :target: https://elective.readthedocs.io/en/latest/?badge=latest

   :alt: Documentation Status



What is elective?

~~~~~~~~~~~~~~~~~



``elective`` is a `Python`_ program configuration loader generator that

can leverage environment variables, configuration files (TOML, JSON,

YAML, BespON), and the command line (via ``argparse``) to generate a

custom loader module to use in your `Python`_ application with a goal of

being able to specify any configurable option identically via any

generation method.  ``elective`` supports customization of the

providers file formats and of the method of combining the results from

all providers.



Roadmap

~~~~~~~



* Allow for configurable provider precedence.

* Allow for configurable provider combination.

* Create left merge, right merge, and join provider combiners.

* Generate boolean options.

* Generate string options.

* Generate number options.

* Generate list options.

* Generate hash options.

* Create configuration object interface.

* Generate dependency requirements for parent projects (pip).

* Generate dependency requirements for parent projects (poetry).

* Allow for configurable file format dependencies.

* Create TOML configuration to generate configuration generators.

* Bootstrap to self-host the ``elective`` configuration generator.

* Generate code that passes the project linting tests.

* Generate an executable entry point to run the generated configuration.

* Generate tests for the generated configuration.



Installation

~~~~~~~~~~~~



Install elective with::



  pip install elective

  pip freeze > requirements.txt



or with poetry::



  poetry add elective



Usage

~~~~~



In code::



  >>> import elective



See the source and `documentation

`_ for more information.



Copyright and License

=====================



SPDX-License-Identifier: `MIT`_



elective, a `Python`_ configuration loader generator.



Copyright (C) 2021-2022 `Jeremy A Gray `_.



Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

"Software"), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:



The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION

OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.



Author

~~~~~~



`Jeremy A Gray `_.



.. _MIT: https://spdx.org/licenses/MIT.html

.. _Python: https://www.python.org/