This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

ConfigIt is MIT Licensed Python Configuration library brought to you by the camera shy people at Pictage.

Python is all about the dicts so why do we settle for INIs?

Features

All configuration files are native python files.

Using ConfigIt you can read those files in as a module, or file and return a dictionary with attribute access.

One of the most powerful things about configit is its ability to use other configurations within a configuration.

Installation

To install configit, simply:

$ pip install configit

API Documentation

configit.conf_from_file(filepath)
Reads a string file path and returns a ConfigDict.
filepath = r'tests/configs/default.py'

config = conf_from_file(filepath)
assert config.config_dict.name == 'default'
configit.conf_from_module(module)
Reads an imported module and returns a ConfigDict.
import tests.configs.module_config

config = conf_from_module(tests.configs.module_config)
assert config.config_dict.name == 'module_config'
configit.conf_from_dict(conf_dict)

Reads a dictionary and returns a ConfigDict.

ConfigDicts are accessible by attributes as well as keys.

config = dict(answer=42)

config = configit.conf_from_dict(config)
assert config.answer == 42
configit.use(conf_source)

Within a python configuration you can import another python configuration. The imported configuration will update local name space of the importing configuration. This means values in sub configuration will be accessible in the local configuration.

This can be useful for boiler plate configurations where you only need a few items changed.

file_supplement.py contents:

answer=42

file.py contents:

import configit
configit.use('file_supplement.py')

Code using configit to get the configuration:

import configit
config = conf_from_file('file.py')

assert config.answer == 42

Order matters!

file_supplement.py contents:

answer=42

file.py contents:

import configit
configit.use('file_supplement.py')
answer=5

Code using configit to get the configuration:

import configit
config = conf_from_file('file.py')

assert config.answer == 5

For further examples refer to included tests.

Contribute

  1. Fork the repository on Github to start making your changes to the develop branch (or branch off of it).

  2. Install to your env or venv by running:

    $ python setup.py develop
    
  3. Hack-a-thon, dance party!

  4. Write a test which shows that the bug was fixed or that the feature works as expected.

  5. Test by running:

    $ python setup.py test
    
  6. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS.

Release History

Release History

1.1

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.3

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.2

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
ConfigIt-1.1.tar.gz (5.1 kB) Copy SHA256 Checksum SHA256 Source Aug 8, 2012

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting