aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 45c366e0a6ec90cd9c77cb05488a354bebd5501f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
<p align="center">
  Config File
</p>

<p align="center">
  <strong>
    Simple manipulation of ini, json, yaml, or toml files
  </strong>
</p>

<p align="center">
  <a href="https://pypi.org/config-file"><img
    src="https://img.shields.io/pypi/pyversions/config-file.svg"
    alt="Python Version"
  /></a>
  <a href="https://pypi.org/config-file"><img
    src="https://img.shields.io/pypi/v/config-file"
    alt="Version"
  /></a>
  <a href="https://builds.sr.ht/~eugenetriguba/config-file?"><img
    src="https://builds.sr.ht/~eugenetriguba/config-file.svg"
    alt="Build Status"
  /></a>
</p>

<p align="center">
  The Config File project is designed to allow you to easily manipulate your
  configuration files with the same simple API whether they are in INI, JSON,
  YAML, or TOML.
</p>

## Quick start

Config File is available to download through PyPI.

```bash
$ pip install config-file
```

### Installing Extras

If you want to manipulate YAML and TOML, you'll want to download the extras as well.

```bash
$ pip install config-file[yaml, toml]
```

For detailed documentation, visit
[config-file.readthedocs.io](https://config-file.readthedocs.io/)

## License

The [MIT](https://github.com/eugenetriguba/config-file/blob/main/LICENSE) License.