Welcome to EZedCfg’s documentation!

Contents:

EZedCfg

A basic configuration loading package

https://img.shields.io/pypi/v/ezedcfg.svg https://img.shields.io/travis/stephenflynn/ezedcfg.svg Documentation Status Updates

This package’s primary purpose is to make it easier to change a programs default configuration by loading a custom configuration file in either YAML format or JSON Format.

It does this by performing a dictionary update on a supplied default configuration.

Installation

pip install ezedcfg

Usage

If you intend using a json configuration file, add json to the object arguments:

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install EZedCfg, run this command in your terminal:

$ pip install ezedcfg

This is the preferred method to install EZedCfg, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for EZedCfg can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/stephenflynn/ezedcfg

Or download the tarball:

$ curl  -OL https://github.com/stephenflynn/ezedcfg/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use EZedCfg in a project:

import ezedcfg

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/stephenflynn/ezedcfg/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

EZedCfg could always use more documentation, whether as part of the official EZedCfg docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/stephenflynn/ezedcfg/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up ezedcfg for local development.

  1. Fork the ezedcfg repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/ezedcfg.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv ezedcfg
$ cd ezedcfg/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 ezedcfg tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.3, 3.4 and 3.5. Check https://travis-ci.org/stephenflynn/ezedcfg/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_ezedcfg

Credits

Development Lead

  • Stephen Flynn

Contributors

None yet. Why not be the first?

History

0.1.8 (2018-03-11)

  • Added pyup.io config file.

0.1.7 (2018-03-11)

  • Removed Python 3.3 support
  • Upgraded dependencies

0.1.5 (2017-09-20)

0.1.4 (2017-09-20)

  • Sundry fixes to allow Travis.ci to push a build to PyPi.

0.1.3 (2017-09-20)

  • Bugfix v2 for testing on python 3.3 and 3.4.

0.1.2 (2017-09-20)

  • Bugfix for testing on python 3.3 and 3.4.

0.1.0 (2017-09-18)

  • First release on PyPI.

Indices and tables