Skip to main content

Simple python package to use a json file as a configuration file

Project description

PyConfigurathon

A python package for making it easy to use and manage configuration files in your python applications.

Installation

Using poetry

`poetry add pyconfigurathon`

Using pip

`pip install pyconfigurathon`

How to use

The recommended way to use this module is to have a module dedicated to your configuration. Eg. config.py

Use with an absolute path to the configuration file:

from pyconfigurathon.configurator import configurator


def get_config(config_name, file_path="/path/to/file/settings.json"):
    cf = configurator(file_path)

    return cf.get(config_key=config_name)

Use with a path to the configuration file relative to the config.py file

import os
from pyconfigurathon.configurator import configurator


def get_config(config_name, file="settings.json"):
    conf = configurator(os.path.join(os.path.dirname(__file__), file))

    return conf.get(config_key=config_name)

Please note that these are only examples to help you get started faster. There are other ways to use this package.

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

pyconfigurathon-0.1.1.1.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

pyconfigurathon-0.1.1.1-py3-none-any.whl (3.7 kB view hashes)

Uploaded Python 3

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