Metadata-Version: 2.1
Name: Super-Config
Version: 0.0.3
Summary: Parse bank cheques
Home-page: https://github.com/ajkdrag/Super-Config
Author: ajkdrag
Author-email: 
Maintainer: ajkdrag
Maintainer-email: 
License: Apache Software License 2.0
Keywords: superconfig,Super-Config,Super_Config,super_config
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: pyyaml
Requires-Dist: smart-open
Provides-Extra: all
Requires-Dist: smart-open[s3] ; extra == 'all'
Requires-Dist: smart-open[gcs] ; extra == 'all'
Provides-Extra: gcs
Requires-Dist: smart-open[gcs] ; extra == 'gcs'
Provides-Extra: s3
Requires-Dist: smart-open[s3] ; extra == 's3'
Provides-Extra: smart_open_gcs_
Requires-Dist: smart-open[gcs] ; extra == 'smart_open_gcs_'
Provides-Extra: smart_open_s3_
Requires-Dist: smart-open[s3] ; extra == 'smart_open_s3_'

|docs_badge| |pypi_badge|

.. |docs_badge| image:: https://img.shields.io/github/deployments/ajkdrag/ocrtoolkit/github-pages?label=docs
   :alt: GitHub-Pages deployment status
   :target: https://ajkdrag.github.io/Super-Config

.. |pypi_badge| image:: https://img.shields.io/pypi/v/Super-Config?color=green
   :alt: PyPI - Version
   :target: https://pypi.org/project/Super-Config/


Super-Config
###################################

Config parsing on steroids.


.. contents::
   :local:

Quickstart
==========

Super-Config is available on PyPI and can be installed with `pip <https://pypi.org/project/Super-Config/>`_.

.. code-block:: console

    $ pip install Super-Config

After installing Super-Config you can use it like any other Python module.

Here is a simple example:

.. code-block:: python

    import superconfig as sc
    from superconfig.superconf import SuperConfig


    def main():
        SuperConfig.setup(
            path_default="configs/default.ini", path_custom="configs/dev.yaml"
        )

        print(SuperConfig.get("LOCAL_PATHS.path"))
        print(SuperConfig.get("CLOUD_PATHS.path"))
        print(SuperConfig.get("ENVIRONMENT_NAME"))
        val = SuperConfig.get("ENVIRONMENT_ID", dtype=sc.INT)
        print(val, type(val))


Documentation
==============

The `API Reference <https://ajkdrag.github.io/Super-Config/>`_ provides API-level documentation


Examples
=========

Refer the `examples <https://github.com/ajkdrag/Super-Config/tree/master/examples>`_ folder in this repository


Credits
========

- `LayConf repo <https://github.com/davidohana/LayConf>`_


.. _change-log-label:

Change Log
==========

Version History
---------------

0.0.1
    * Project created.


