blob: c59d5fa1294f9df1518d48157c29c9bbc121ce30 (
plain)
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
55
56
57
58
59
60
61
62
63
64
65
66
|
# configobj
[](https://travis-ci.org/DiffSK/configobj)
[](https://coveralls.io/r/DiffSK/configobj?branch=master)
[](https://pypi.python.org/pypi/configobj)
[](https://pypi.python.org/pypi/configobj)
[](https://github.com/DiffSK/configobj/blob/master/LICENSE)
Python 3+ compatible port of the [configobj](https://pypi.python.org/pypi/configobj/) library.
## Documentation
You can find a full manual on how to use ConfigObj at [readthedocs](http://configobj.readthedocs.io/).
If you want to *work on the project*, please see the [Contributing](#contributing) section below.
## Status
This project is now maintained by [Eli Courtwright](https://github.com/EliAndrewC) and [Rob Dennis](https://github.com/robdennis) with the blessing of original creator [Michael Foord](http://www.voidspace.org.uk/).
For long time ConfigObj users, the biggest change is in the officially supported Python versions (it *was* 2.3 … 2.6):
* 2.6 … 2.7
* 3.3 … 3.6
Other Python3 versions may work, but this is what *Travis* and ``tox`` use to run the tests on commit.
## Roadmap
- Fixing any issues introduced as a result of the added Python 3 support
- Moving tests away from doctests in favor of pytest (reasonable now that versions older than 2.6 are dropped)
- Considering new features that work in a backwards-compatible way (feel free to open an issue with your suggestion)
- Also see the [milestones](https://github.com/DiffSK/configobj/milestones)
## Contributing
Contributing to this project is easy, and reporting an issue or
adding to the documentation also improves things for every user.
You don’t need to be a developer to contribute.
See [CONTRIBUTING](https://github.com/DiffSK/configobj/blob/master/CONTRIBUTING.md) for more.
As a documentation author or developer,
to **create a working directory** for this project,
call these commands:
```sh
git clone "https://github.com/DiffSK/configobj.git"
cd "configobj"
command . .env --yes --develop # add '--virtualenv /usr/bin/virtualenv' for Python2
invoke build --docs test doctest check
```
For this to work, you might also need to follow some
[setup procedures](https://py-generic-project.readthedocs.io/en/latest/installing.html#quick-setup)
to make the necessary basic commands available on *Linux*, *Mac OS X*, and *Windows*.
**Running the test suite** can be done several ways, just call ``invoke test`` for a quick check,
or ``invoke test.tox`` for testing with all supported Python versions
(if you [have them available](https://github.com/jhermann/priscilla/tree/master/pyenv)).
Use ``invoke check`` to **run a code-quality scan**.
To **start a watchdog that auto-rebuilds documentation** and reloads the opened browser tab on any change,
call ``invoke docs -w -b`` (stop the watchdog using the ``-k`` option).
|
