summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRob Dennis <rdennis@gmail.com>2023-01-17 16:58:24 -0500
committerGitHub <noreply@github.com>2023-01-17 16:58:24 -0500
commit62c2c88688e5ff110792bb0d0547c5206bd036c7 (patch)
treeb91f297fce6a249f770272e6d6cf356687f2b379 /README.md
parent148d8f8045fb72a00898057d156db40540918f78 (diff)
parent500cdaa38b55571a47f9ecbdf237cbc303476b27 (diff)
downloadconfigobj-git-62c2c88688e5ff110792bb0d0547c5206bd036c7.tar.gz
Merge pull request #228 from DiffSK/5.0.xv5.0.7
Teeing up version 5.0.7
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 33 insertions, 20 deletions
diff --git a/README.md b/README.md
index 186a309..e55cf52 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,40 @@
-configobj [![Build Status](https://travis-ci.org/DiffSK/configobj.svg?branch=master)](https://travis-ci.org/DiffSK/configobj)[![Downloads](https://pypip.in/d/configobj/badge.png)](https://crate.io/packages/configobj)[![PyPI version](https://badge.fury.io/py/configobj.png)](http://badge.fury.io/py/configobj)[![Coverage Status](https://coveralls.io/repos/DiffSK/configobj/badge.png?branch=master)](https://coveralls.io/r/DiffSK/configobj?branch=master)
-=========
+# configobj
+[![Coverage Status](https://img.shields.io/coveralls/DiffSK/configobj.svg)](https://coveralls.io/r/DiffSK/configobj?branch=master)
+[![PyPI version](http://img.shields.io/pypi/v/configobj.svg)](https://pypi.python.org/pypi/configobj)
+[![License](https://img.shields.io/badge/license-BSD_3--clause-red.svg)](https://github.com/DiffSK/configobj/blob/master/LICENSE)
+
Python 3+ compatible port of the [configobj](https://pypi.python.org/pypi/configobj/) library.
-Documentation
-=========
-Found at [readthedocs](http://configobj.readthedocs.org/)
+The Github CI/CD Pipeline runs tests on python versions:
+- 2.7
+- 3.5
+- 3.6
+- 3.7
+- 3.8
+- 3.9
+- 3.10
+- 3.11
-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:
-- 2.6
-- 2.7
-- 3.2
-- 3.3
+## Documentation
+
+You can find a full manual on how to use ConfigObj at [readthedocs](http://configobj.readthedocs.io/).
+
+## Status
+
+This is a mature project that is not actively maintained at this time.
-(notably adding python 3 support; previously this was 2.3 - 2.6)
-Other versions may work, but this is what travis and tox uses to run the tests on commit.
+## Past Contributors:
-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)
+- [Michael Foord](https://agileabstractions.com/)
+ - original creator of ``configobj`` and ``validate`` and maintainer through version 4
+- [Rob Dennis](https://github.com/robdennis)
+ - released version 5 (first python 3-compatible release) in 2014, bringing the project to github
+ - released the last maintenance release (until new maintainership is established) in 2023
+- [Eli Courtwright](https://github.com/EliAndrewC)
+ - released version 5 (first python 3-compatible release) in 2014
+- [Nicola Larosa](https://pypi.org/user/tekNico/)
+ - Contributions to the pre-version 5 codebase
+- [Jürgen Hermann](https://github.com/jhermann)
+ - day-to-day maintenance of the repo