Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Dead simple configuration file parser.

Project description

https://travis-ci.org/kisom/pysimpleconfig.svg?branch=master

what?

simpleconfig is a Python module that reads INI files into a dictionary. It is both Python 2 and Python 3 compatible.

why?

I’ve written this code several times for a couple projects; I got sick of copying the file over to new project directories.

how?

Both a parse and parse_string function are provided. The former parses config files, and the latter parses a config file serialised into a string.

return value and example

Both parse() and parse_string return a dictionary (see below) where each section is a key at the top level, and is a dictionary of key=value pairs itself. For example, given the config file:

>>> config = """
# random version information
version = 1.0.5

; last modified 1 April 2001 by John Doe
; example taken from wikipedia
[owner]
name=John Doe
organization=Acme Widgets Inc.

[database]
# use IP address in case network name resolution is not working
server=192.0.2.62
port=143
file="payroll.dat"
"""

Parsing this with simpleconfig yields:

>>> import simpleconfig as sc
>>> cfg = sc.parse_string(config)
>>> cfg['owner']['name']
'John Doe'
>>> cfg.owner.name
'John Doe'

Note that the dictionary type returned by the parse functions is actually a kutils.dicts.AttrDictDict, which is derived from the dict type and can be used wherever a dict can.

license

simpleconfig is released under an ISC license.

author

simpleconfig was written by Kyle Isom <coder@kyleisom.net>.

additional

The module is only tested for compatibility against Python 2.7 and Python 3.3+. There are no guarantees (or attempts) at compatibility with previous version of Python.

The docs are on RTD.

The source for simpleconfig is online:

Project details


Release history Release notifications

This version
History Node

2.0

History Node

1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
simpleconfig-2.0-py2-none-any.whl (4.9 kB) Copy SHA256 hash SHA256 Wheel py2 Jun 22, 2017
simpleconfig-2.0-py3-none-any.whl (4.9 kB) Copy SHA256 hash SHA256 Wheel py3 Jun 22, 2017
simpleconfig-2.0.tar.gz (2.6 kB) Copy SHA256 hash SHA256 Source None Jun 22, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page