Skip to main content

Kids config loading helpers.

Project description

Latest PyPI version Number of PyPI downloads Travis CI build status Test coverage

kids.cfg is a Python library providing helpers for loading your cfg file.

It’s part of ‘Kids’ (for Keep It Dead Simple) library.

Maturity

This code is in alpha stage. It wasn’t tested on Windows. API may change. This is more a draft for an ongoing reflection.

And I should add this is probably not ready to show. Although, a lot of these function are used everyday in my projects and I got sick rewritting them for every project.

Features

using kids.cfg:

  • TBD

Compatibility

Tis code is python2 and python3 ready. It wasn’t tested on windows.

Installation

You don’t need to download the GIT version of the code as kids.cfg is available on the PyPI. So you should be able to run:

pip install kids.cfg

If you have downloaded the GIT sources, then you could add install the current version via traditional:

python setup.py install

And if you don’t have the GIT sources but would like to get the latest master or branch from github, you could also:

pip install git+https://github.com/0k/kids.cfg

Or even select a specific revision (branch/tag/commit):

pip install git+https://github.com/0k/kids.cfg@master

Usage

TBD

Contributing

Any suggestion or issue is welcome. Push request are very welcome, please check out the guidelines.

Push Request Guidelines

You can send any code. I’ll look at it and will integrate it myself in the code base and leave you as the author. This process can take time and it’ll take less time if you follow the following guidelines:

  • check your code with PEP8 or pylint. Try to stick to 80 columns wide.

  • separate your commits per smallest concern.

  • each commit should pass the tests (to allow easy bisect)

  • each functionality/bugfix commit should contain the code, tests, and doc.

  • prior minor commit with typographic or code cosmetic changes are very welcome. These should be tagged in their commit summary with !minor.

  • the commit message should follow gitchangelog rules (check the git log to get examples)

  • if the commit fixes an issue or finished the implementation of a feature, please mention it in the summary.

If you have some questions about guidelines which is not answered here, please check the current git log, you might find previous commit that would show you how to deal with your issue.

License

Copyright (c) 2015 Valentin Lab.

Licensed under the BSD License.

Changelog

0.0.3 (2015-03-04)

New

  • Can access conf files not yet created but listed. [Valentin Lab]

    If you had listed a local file in REPOS/.foo.rc and a global config file in ~/.foo.rc then you can store values and access them now via MConfig and the file will then get created.

  • Full support YAML, configobj, python config file, and multilayers config files. [Valentin Lab]

    • autodetection of syntax

    • 3 syntax provided: YAML, configobj, python config

    • write support provided for: YAML, configobj

Changes

  • Use safe_load when parsing Yaml instead of load. [Valentin Lab]

    If we have a valid reason to use load we’ll consider putting it back.

0.0.1 (2014-05-14)

  • First import. [Valentin Lab]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kids.cfg-0.0.3.tar.gz (11.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page