aboutsummaryrefslogtreecommitdiffstats
path: root/docs/installation.md
blob: a1212bce67654dc0c6e0a319330411bb0a7c74e4 (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
# Installation

Config File is available to download through PyPI and can be installed using pip.
It requires Python 3.9+ to install.

## Basic Installation

For basic functionality with INI and JSON support:

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

This will install the core package with support for:

- **INI files** (using Python's built-in `configparser`)
- **JSON files** (using Python's built-in `json`)

## Installing with Extras

If you want to work with YAML and TOML files, you'll need to install the optional dependencies:

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