pyconfs

Unified handling of configuration files in Python

https://github.com/gahjelle/pyconfs

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.1%) to scientific vocabulary

Keywords

configuration ini json python toml yaml
Last synced: 6 months ago · JSON representation ·

Repository

Unified handling of configuration files in Python

Basic Info
Statistics
  • Stars: 17
  • Watchers: 4
  • Forks: 2
  • Open Issues: 2
  • Releases: 13
Topics
configuration ini json python toml yaml
Created over 6 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Citation

README.md

PyConfs

Unified handling of configuration files in Python

Latest version Python versions Code style: black Interrogate DocStrings unit_tests

Note: For new projects, use Configaroo instead.

Installing PyConfs

PyConfs is available at PyPI. You can install it using Pip:

$ python -m pip install pyconfs

Using PyConfs

A PyConfs Configuration is a dictionary-like object that unifies several different configuration file formats, including INI, JSON, TOML, and YAML.

Read a configuration from file:

from pyconfs import Configuration
cfg = Configuration.from_file("sample.json")

Access entries in a configuration:

package_name = cfg.name
first_name = cfg.author.firstname

Installing From Source

You can always download the latest version of PyConfs from GitHub. PyConfs uses Flit as a setup tool.

To install PyConfs from the downloaded source, run Flit:

$ python -m flit install --deps production

If you want to change and play with the PyConfs source code, you should install it in editable mode:

$ python -m flit install --symlink

Owner

  • Name: Geir Arne Hjelle
  • Login: gahjelle
  • Kind: user
  • Location: Oslo, Norway
  • Company: @realpython

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
title: "PyConfs"
abstract: "Unified handling of configuration files in Python"
authors:
  - family-names: "Hjelle"
    given-names: "Geir Arne"
version: 0.5.7
date-released: 2019-10-01
repository-code: "https://github.com/gahjelle/pyconfs"
license: MIT
keywords:
    - "toml"
    - "json"
    - "ini"
    - "yaml"
    - "yml"
    - "configuration"
    - "config"

GitHub Events

Total
  • Push event: 1
  • Pull request event: 1
  • Fork event: 1
  • Create event: 1
Last Year
  • Push event: 1
  • Pull request event: 1
  • Fork event: 1
  • Create event: 1

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 97
  • Total Committers: 2
  • Avg Commits per committer: 48.5
  • Development Distribution Score (DDS): 0.031
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Geir Arne Hjelle g****e@g****m 94
Lewi Uberg 4****g 3

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 4
  • Total pull requests: 19
  • Average time to close issues: about 6 hours
  • Average time to close pull requests: 7 days
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.21
  • Merged pull requests: 18
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • gahjelle (3)
  • lewiuberg (1)
Pull Request Authors
  • gahjelle (16)
  • lewiuberg (4)
Top Labels
Issue Labels
bug (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 48,508 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 21
  • Total maintainers: 1
pypi.org: pyconfs

PyConfs, unified handling of configuration files for Python

  • Versions: 21
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 48,508 Last month
Rankings
Downloads: 2.8%
Dependent packages count: 4.7%
Average: 12.7%
Stargazers count: 15.2%
Forks count: 19.1%
Dependent repos count: 21.7%
Maintainers (1)
Last synced: 6 months ago

Dependencies

requirements.in pypi
  • PyYAML *
  • importlib_resources *
  • pyplugs *
  • toml *