{ "info": { "author": "Nicolas Maurice", "author_email": "nicolas.maurice.valera@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "Some rights reserved.\n\nRedistribution and use in source and binary forms of the software as well\nas documentation, with or without modification, are permitted provided\nthat the following conditions are met:\n\n* Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the above\n copyright notice, this list of conditions and the following\n disclaimer in the documentation and/or other materials provided\n with the distribution.\n\n* Neither the name of Config-Loader nor the names of the contributors may not be used to endorse or\n promote products derived from this software without specific\n prior written permission.\n\nTHIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND\nCONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT\nNOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER\nOR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE AND DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH\nDAMAGE.\nDescription: .. image:: https://travis-ci.org/nmvalera/cfg-loader.svg?branch=master\n :target: https://travis-ci.org/nmvalera/cfg-loader\n :alt: Build Status\n \n .. image:: https://codecov.io/gh/nmvalera/cfg-loader/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/nmvalera/cfg-loader\n :alt: Coverage\n \n .. image:: https://readthedocs.org/projects/cfg-loader/badge/?version=stable\n :target: https://cfg-loader.readthedocs.io/en/stable/?badge=stable\n :alt: Documentation Status\n \n Cfg-Loader\n ==========\n \n Cfg-Loader is a library that allows to easily load configuration settings.\n It uses `marshmallow`_ to deserialize input data into a target format configuration data.\n \n Main features\n ~~~~~~~~~~~~~\n \n - input data validation and automatic processing using `marshmallow`_\n - substitution of environment variables in input data (following `docker compose variable substitution syntax`_)\n - configuration loading from .yaml file\n \n .. _`marshmallow`: https://github.com/marshmallow-code/marshmallow\n .. _`docker compose variable substitution syntax`: https://docs.docker.com/compose/compose-file/#variable-substitution\n \n Requirements\n ~~~~~~~~~~~~\n \n - Python>=3.5\n \n A simple example\n ~~~~~~~~~~~~~~~~\n \n .. code-block:: python\n \n >>> from cfg_loader import ConfigSchema, BaseConfigLoader\n >>> from marshmallow import fields\n \n # Declare your configuration schema\n >>> class MyConfigSchema(ConfigSchema):\n ... setting1 = fields.Str()\n ... setting2 = fields.Int(required=True)\n ... setting3 = fields.Float(missing=13.2)\n \n # Declare mapping to substitute environment variable\n >>> substitution_mapping = {'FILE_PATH': 'file'}\n \n # Initialize config loader\n >>> my_config_loader = BaseConfigLoader(MyConfigSchema, substitution_mapping=substitution_mapping)\n \n # Load configuration\n >>> config = my_config_loader.load({'setting1': '/home/folder/${FILE_PATH?:file path required}', 'setting2': '4'})\n >>> config == {'setting1': '/home/folder/file', 'setting2': 4, 'setting3': 13.2}\n True\n \n # Invalid input data\n >>> my_config_loader.load({'setting1': '/home/folder/${FILE_PATH?:file path required}', 'setting3': 13.4})\n Traceback (most recent call last):\n ...\n cfg_loader.exceptions.ValidationError: {'setting2': ['Missing data for required field.']}\n \n >>> my_config_loader.load({'setting2': 12, 'setting3': 'string'})\n Traceback (most recent call last):\n ...\n cfg_loader.exceptions.ValidationError: {'setting3': ['Not a valid number.']}\n \n # Variable substitution invalid\n >>> my_config_loader.load({'setting2': '${UNSET_VARIABLE?Variable \"UNSET_VARIABLE\" required}'})\n Traceback (most recent call last):\n ...\n cfg_loader.exceptions.UnsetRequiredSubstitution: Variable \"UNSET_VARIABLE\" required\n \n Documentation\n ~~~~~~~~~~~~~\n \n Full documentation is available at https://cfg-loader.readthedocs.io/en/stable/.\nPlatform: any\nClassifier: Development Status :: 5 - Production/Stable\nClassifier: Environment :: Web Environment\nClassifier: Intended Audience :: Developers\nClassifier: License :: OSI Approved :: BSD License\nClassifier: Operating System :: OS Independent\nClassifier: Programming Language :: Python\nClassifier: Programming Language :: Python :: 3\nClassifier: Programming Language :: Python :: 3.5\nClassifier: Programming Language :: Python :: 3.6\nProvides-Extra: dev\nProvides-Extra: doc\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/nmvalera/cfg-loader", "keywords": "", "license": "Copyright (c) 2017 by ConsenSys France and contributors.", "maintainer": "ConsenSys France", "maintainer_email": "", "name": "Cfg-Loader", "package_url": "https://pypi.org/project/Cfg-Loader/", "platform": "", "project_url": "https://pypi.org/project/Cfg-Loader/", "project_urls": { "Homepage": "https://github.com/nmvalera/cfg-loader" }, "release_url": "https://pypi.org/project/Cfg-Loader/0.2.2/", "requires_dist": [ "marshmallow (==3.0.0b11)", "PyYAML (>=3.12)", "flake8; extra == 'dev'", "autoflake; extra == 'dev'", "autopep8; extra == 'dev'", "coverage; extra == 'dev'", "pytest (>=3); extra == 'dev'", "tox; extra == 'dev'", "sphinx; extra == 'dev'", "sphinx-rtd-theme; extra == 'dev'", "sphinx; extra == 'doc'", "sphinx-rtd-theme; extra == 'doc'" ], "requires_python": "", "summary": "A library that allows to easily load configuration settings.", "version": "0.2.2" }, "last_serial": 4106735, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "dc62c30a847b4581e02c021f1cc1e1a3", "sha256": "e195b815d2504d3f02aa4d17606a7821355b02f034e0732189e9e6b1315474ed" }, "downloads": -1, "filename": "Cfg_Loader-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "dc62c30a847b4581e02c021f1cc1e1a3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15704, "upload_time": "2018-05-30T02:07:03", "url": "https://files.pythonhosted.org/packages/aa/e1/f72e13cb1566d53224ce48eea4b307eb76ef6dead6bf4865a81b13a2531e/Cfg_Loader-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1ecc6ba449f6ab4ab5d528f0b0a92798", "sha256": "0a7d709706d0b3be4c566ba62b87603f3bc44d5118b2d2d7968a486298d54519" }, "downloads": -1, "filename": "Cfg-Loader-0.1.1.tar.gz", "has_sig": false, "md5_digest": "1ecc6ba449f6ab4ab5d528f0b0a92798", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17476, "upload_time": "2018-05-30T02:07:04", "url": "https://files.pythonhosted.org/packages/9e/4b/c8f11bc4eb619e259e59d93338f3e0dfe82912519c2aba9bd7b44513f1e5/Cfg-Loader-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "2cfa326553f23f44589d6044793dd011", "sha256": "349eba05abb172c4a56c148a176896cc90d445fb70f56252701e2a8fa7150650" }, "downloads": -1, "filename": "Cfg_Loader-0.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "2cfa326553f23f44589d6044793dd011", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15772, "upload_time": "2018-05-30T02:17:24", "url": "https://files.pythonhosted.org/packages/e0/19/3ddede3fb96583ba63594fdda3e84b255a337c13424320d2e373b003abea/Cfg_Loader-0.1.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "39bb1ad03470fb55035d940f056334a3", "sha256": "9af701827a2c32db8ec1257c22991c39c734a6a44edafaadda449431d4d011ba" }, "downloads": -1, "filename": "Cfg-Loader-0.1.2.tar.gz", "has_sig": false, "md5_digest": "39bb1ad03470fb55035d940f056334a3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17618, "upload_time": "2018-05-30T02:17:25", "url": "https://files.pythonhosted.org/packages/1e/de/3ff84448dd8ea5d02d72ab8415e054db2da5f81116e9ab8920089f51d4fa/Cfg-Loader-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "90e31c7aea4f501011fc84b56e2c989f", "sha256": "bcf4415e09065f284aad5085c0a9b62c3f8bc3730f4708943cc60474918907be" }, "downloads": -1, "filename": "Cfg_Loader-0.1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "90e31c7aea4f501011fc84b56e2c989f", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15812, "upload_time": "2018-05-30T15:48:04", "url": "https://files.pythonhosted.org/packages/76/2a/a022223e0008b54c4f7af58abde35ea14e6be10d86fd41c4035de77bf256/Cfg_Loader-0.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d85a6ec1e9361f7a9ceb147fe0b8e66b", "sha256": "fe1f0db5b08ee224e837f03b5e3462e17cdc7426111679a45ce5ee81fda5efff" }, "downloads": -1, "filename": "Cfg-Loader-0.1.3.tar.gz", "has_sig": false, "md5_digest": "d85a6ec1e9361f7a9ceb147fe0b8e66b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17840, "upload_time": "2018-05-30T15:48:05", "url": "https://files.pythonhosted.org/packages/6f/c1/92343fe1f01497b27b3ac5e7151290f31aec018cf587b28f2e2a3730da48/Cfg-Loader-0.1.3.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "a491b7b0d1e50150a299c23f46c0fef9", "sha256": "8497b69186994dd3658ddce2e22d4583fb9565da935db535f0b870fb14233019" }, "downloads": -1, "filename": "Cfg_Loader-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a491b7b0d1e50150a299c23f46c0fef9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15876, "upload_time": "2018-06-01T15:46:10", "url": "https://files.pythonhosted.org/packages/b7/19/d0890fe68104873e51e09dba877354522b46d6d28bc241d7a2ae20d54132/Cfg_Loader-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "41056d1da981e237bfc18bc414204169", "sha256": "ea8a008a569175947ecbbf9fd2653a41836023182779ad067202c2206ae12d83" }, "downloads": -1, "filename": "Cfg-Loader-0.2.0.tar.gz", "has_sig": false, "md5_digest": "41056d1da981e237bfc18bc414204169", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17957, "upload_time": "2018-06-01T15:46:11", "url": "https://files.pythonhosted.org/packages/6f/6a/d140dea9c85aa2c5b12ed116e3508f6de2a4492c768cd6a28790536b4c6d/Cfg-Loader-0.2.0.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "62c4943cefa3631267c15b86fcbc5d7c", "sha256": "b5be16d5fa89a9839503b2c4470039f4224f8d01a85f4679d51cec6eb1877237" }, "downloads": -1, "filename": "Cfg_Loader-0.2.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "62c4943cefa3631267c15b86fcbc5d7c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15992, "upload_time": "2018-07-26T23:09:45", "url": "https://files.pythonhosted.org/packages/22/52/466daa9fa1c29c3234c00682033091f43125c738f9236159427a9a7c6f9a/Cfg_Loader-0.2.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1c960d7817a3745126341913ae5ace28", "sha256": "3fd2c7e73d5523e2682d8bb42202e670018e7563af043f2a9f8a74d9a03f8101" }, "downloads": -1, "filename": "Cfg-Loader-0.2.2.tar.gz", "has_sig": false, "md5_digest": "1c960d7817a3745126341913ae5ace28", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18376, "upload_time": "2018-07-26T23:09:46", "url": "https://files.pythonhosted.org/packages/d3/d8/1232d76cec8824f165fda7616b7de430e2825c7822cf054c1b815611fc89/Cfg-Loader-0.2.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "62c4943cefa3631267c15b86fcbc5d7c", "sha256": "b5be16d5fa89a9839503b2c4470039f4224f8d01a85f4679d51cec6eb1877237" }, "downloads": -1, "filename": "Cfg_Loader-0.2.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "62c4943cefa3631267c15b86fcbc5d7c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15992, "upload_time": "2018-07-26T23:09:45", "url": "https://files.pythonhosted.org/packages/22/52/466daa9fa1c29c3234c00682033091f43125c738f9236159427a9a7c6f9a/Cfg_Loader-0.2.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1c960d7817a3745126341913ae5ace28", "sha256": "3fd2c7e73d5523e2682d8bb42202e670018e7563af043f2a9f8a74d9a03f8101" }, "downloads": -1, "filename": "Cfg-Loader-0.2.2.tar.gz", "has_sig": false, "md5_digest": "1c960d7817a3745126341913ae5ace28", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18376, "upload_time": "2018-07-26T23:09:46", "url": "https://files.pythonhosted.org/packages/d3/d8/1232d76cec8824f165fda7616b7de430e2825c7822cf054c1b815611fc89/Cfg-Loader-0.2.2.tar.gz" } ] }