commented-configparser 1.0.0__tar.gz → 2.0.0__tar.gz

commented_configparser-2.0.0/.flake8

@@ -0,0 +1,7 @@
+[flake8]
+# E501: Allow lines to be too long (black will take care of it)
+# E203: Allow whitespace before ':'
+extend-ignore =
+    E501
+    E203
+max-line-length = 88

commented_configparser-2.0.0/.github/workflows/python-tests.yml

@@ -0,0 +1,108 @@
+name: "python tests and coverage"
+# Uses:
+# https://github.com/actions/setup-python
+# https://github.com/actions/checkout
+# https://github.com/actions/download-artifact
+# https://github.com/actions/upload-artifact
+
+on:
+  pull_request:
+    branches:
+      - "*"
+  push:
+    branches:
+      - "main"
+
+jobs:
+  run-tests-and-coverage:
+    name: "Run nox for tests and coverage"
+    runs-on: "${{ matrix.os }}"
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - "macos-latest"
+          - "windows-latest"
+          - "ubuntu-latest"
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+
+    steps:
+      - name: "Repo checkout"
+        uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11"
+
+      - name: "Set up Python ${{ matrix.python-version }}"
+        uses: "actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c"
+        with:
+          python-version: "${{ matrix.python-version }}"
+          allow-prereleases: true
+
+      - name: "Install nox"
+        run: |
+          python -m pip install --upgrade pip nox
+
+      - name: "Run tests and coverage via nox"
+        run: |
+          nox --session tests_with_coverage-${{ matrix.python-version }}
+
+      - name: "Save coverage artifact"
+        uses: "actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3"
+        with:
+          name: "coverage-artifact-${{ matrix.os}}-${{ matrix.python-version}}"
+          path: ".coverage.*"
+          retention-days: 1
+
+  coverage-compile:
+    name: "coverage compile"
+    needs: "run-tests-and-coverage"
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Repo checkout"
+        uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11"
+
+      - name: "Set up Python"
+        uses: "actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c"
+        with:
+          python-version: "3.12"
+
+      - name: "Install nox"
+        run: |
+          python -m pip install --upgrade pip nox
+
+      - name: "Download coverage artifacts"
+        uses: "actions/download-artifact@c850b930e6ba138125429b7e5c93fc707a7f8427"
+        with:
+          pattern: "coverage-artifact-*"
+          merge-multiple: true
+
+      - name: "Compile coverage data, print report"
+        run: |
+          nox --session coverage_combine_and_report
+          export TOTAL=$(python -c "import json;print(json.load(open('coverage.json'))['totals']['percent_covered_display'])")
+          echo "TOTAL=$TOTAL" >> $GITHUB_ENV
+          echo "### Total coverage: ${TOTAL}%" >> $GITHUB_STEP_SUMMARY
+
+  mypy-check:
+    name: "mypy strict enforcement"
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Repo checkout"
+        uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11"
+
+      - name: "Set up Python"
+        uses: "actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c"
+        with:
+          python-version: "3.12"
+
+      - name: "Install nox"
+        run: |
+          python -m pip install --upgrade pip nox
+
+      - name: "Enforce strict type annotations with mypy"
+        run: |
+          nox --session mypy_check

commented_configparser-2.0.0/.gitignore

@@ -0,0 +1,14 @@
+temp_*
+.env
+venv/
+*egg-info/
+.tox/
+.coverage
+.coverage.*
+coverage.xml
+coverage.json
+htmlcov/
+build/
+dist/
+__pycache__/
+.vscode/

commented_configparser-2.0.0/.pre-commit-config.yaml

@@ -0,0 +1,50 @@
+ci:
+  autoupdate_schedule: monthly
+exclude: ^.+\.ini$
+repos:
+  # Batch of helpful formatters and patterns
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.6.0"
+    hooks:
+      - id: check-json
+      - id: check-toml
+      - id: check-yaml
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-docstring-first
+      - id: debug-statements
+      - id: mixed-line-ending
+
+  # Adds a standard feel to import segments
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args:
+          - "--force-single-line-imports"
+          - "--add-import"
+          - "from __future__ import annotations"
+          - "--profile"
+          - "black"
+
+  # Format code. No, I don't like everything black does either.
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.4.2
+    hooks:
+      - id: black
+
+  # Flake8 for linting, line-length adjusted to match Black default
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.1.0
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - flake8-builtins
+          - flake8-pep585
+          - pep8-naming
+
+  # Type enforcement for Python
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.1
+    hooks:
+      - id: mypy

commented_configparser-2.0.0/CONTRIBUTING.md

@@ -0,0 +1,186 @@
+# Contributing
+
+Before contributing, please either ask to claim an existing open issue or create
+a new issue to discuss your proposed changes with the owner(s) of this repo
+before making any changes.
+
+Any pull requests without a clearly defined issue being solved will be closed.
+
+### Bug reports
+
+Found a bug but do not have time or do not wish to contribute a fix? Please
+submit an issue for our awareness. Your feedback drives the continued
+development of the project!
+
+### Pull Request
+
+All pull requests must:
+
+- Pass all linting and formatting checks
+- Have tests that cover all branches of the added feature
+- If the PR is a bug fix there must be a test that duplicates the bug, proving
+  it is fixed
+
+### Code Style
+
+Follow the patterns seen in the code. Walk where others have walked.
+
+The majority of code style nits will be met when passing `pre-commit` checks
+prior to submitting a pull request.
+
+### Tests
+
+  - Smaller tests are easier to work with
+  - Mock at a minimum
+  - No test should be dependent on another
+  - No test should be dependent on secrets/tokens
+
+
+---
+
+# Local developer installation
+
+The following steps outline how to install this repo for local development.
+
+## Prerequisites
+
+### Clone repo
+
+```console
+git clone https://github.com/Preocts/commented-configparser
+
+cd commented-configparser
+```
+
+### Virtual Environment
+
+Use a ([`venv`](https://docs.python.org/3/library/venv.html)), or equivalent,
+when working with python projects. Leveraging a `venv` will ensure the installed
+dependency files will not impact other python projects or any system
+dependencies.
+
+**Windows users**: Depending on your python install you will use `py` in place
+of `python` to create the `venv`.
+
+**Linux/Mac users**: Replace `python`, if needed, with the appropriate call to
+the desired version while creating the `venv`. (e.g. `python3` or `python3.12`)
+
+**All users**: Once inside an active `venv` all systems should allow the use of
+`python` for command line instructions. This will ensure you are using the
+`venv`'s python and not the system level python.
+
+### Create the `venv`:
+
+```console
+python -m venv venv
+```
+
+Activate the `venv`:
+
+```console
+# Linux/Mac
+. venv/bin/activate
+
+# Windows
+venv\Scripts\activate
+```
+
+The command prompt should now have a `(venv)` prefix on it. `python` will now
+call the version of the interpreter used to create the `venv`
+
+To deactivate (exit) the `venv`:
+
+```console
+deactivate
+```
+
+---
+
+## Developer Installation Steps
+
+### Install editable library and development requirements
+
+```console
+python -m pip install --editable .[dev,test]
+```
+
+### Install pre-commit [(see below for details)](#pre-commit)
+
+```console
+pre-commit install
+```
+
+### Install with nox
+
+If you have `nox` installed with `pipx` or in the current venv you can use the
+following session. This is an alternative to the two steps above.
+
+```console
+nox -s install
+```
+
+---
+
+## Pre-commit and nox tools
+
+### Run pre-commit on all files
+
+```console
+pre-commit run --all-files
+```
+
+### Run tests with coverage (quick)
+
+```console
+nox -e coverage
+```
+
+### Run tests (slow)
+
+```console
+nox
+```
+
+### Build dist
+
+```console
+nox -e build
+```
+
+---
+
+## Updating dependencies
+
+New dependencys can be added to the `requirements-*.in` file. It is recommended
+to only use pins when specific versions or upgrades beyond a certain version are
+to be avoided. Otherwise, allow `pip-compile` to manage the pins in the
+generated `requirements-*.txt` files.
+
+Once updated following the steps below, the package can be installed if needed.
+
+### Update the generated files with changes
+
+```console
+nox -e update
+```
+
+### Upgrade all generated dependencies
+
+```console
+nox -e upgrade
+```
+
+---
+
+## [pre-commit](https://pre-commit.com)
+
+> A framework for managing and maintaining multi-language pre-commit hooks.
+
+This repo is setup with a `.pre-commit-config.yaml` with the expectation that
+any code submitted for review already passes all selected pre-commit checks.
+
+---
+
+## Error: File "setup.py" not found
+
+Update `pip` to at least version 22.3.1

{commented-configparser-1.0.0 → commented_configparser-2.0.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Preocts
+Copyright (c) 2024 Preocts
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

commented_configparser-2.0.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.1
+Name: commented-configparser
+Version: 2.0.0
+Summary: Custom ConfigParser class that preserves comments in file when writing
+Author-email: Preocts <preocts@preocts.com>
+License: MIT License
+        
+        Copyright (c) 2024 Preocts
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: homepage, https://github.com/Preocts/commented-configparser
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: flake8-builtins; extra == "dev"
+Requires-Dist: flake8-pep585; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-randomly; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: nox; extra == "test"
+
+[![Python 3.8 | 3.9 | 3.10 | 3.11 | 3.12 | 3.13](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/downloads)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Preocts/commented-configparser/main.svg)](https://results.pre-commit.ci/latest/github/Preocts/commented-configparser/main)
+[![Python tests](https://github.com/Preocts/commented-configparser/actions/workflows/python-tests.yml/badge.svg?branch=main)](https://github.com/Preocts/commented-configparser/actions/workflows/python-tests.yml)
+
+# commented-configparser
+
+A custom ConfigParser class that preserves comments and option casing when writing loaded config out.
+
+This library gives you a custom class of the standard library's `configparser.ConfigParger` which will preserve the comments of a loaded config file when writing that file back out.
+
+---
+
+## Install via pip
+
+From pypi:
+
+```bash
+python -m pip install commented-configparser
+```
+
+From github:
+
+```bash
+python -m pip install commented-configparser@git+https://github.com/Preocts/commented-configparser@x.x.x
+```
+
+**Note:** Replace `x.x.x` with the desired tag or branch.
+
+---
+
+## Example use
+
+```py
+from commentedconfigparser import CommentedConfigParser
+
+# Load the config like normal
+config = CommentedConfigParser()
+config.read("myconfig.ini")
+
+# Use the config like normal
+...
+
+# Update the config like normal
+...
+
+# Save the config back to the file
+with open("myconfig.ini", "w") as savefile:
+    config.write(savefile)
+```
+
+## Results
+
+We favor the line spacing choices of the `ConfigParser` class so the input format may not be preserved completely. However, the comments will be preserved.
+
+### Before
+
+```ini
+# Welcome to our config
+[DEFAULT]
+# This value has some meaning to someone
+foo=bar
+# Make sure to add this when you need it
+trace=false
+logging=true
+; This is a comment as well
+
+    # so we need to track all of them
+
+	; and many could be between things
+[NEW SECTION]
+# Another comment
+multi-line=
+	value01
+	value02
+	value03
+closing=0
+# Trailing comment
+
+```
+
+### After
+
+```ini
+# Welcome to our config
+[DEFAULT]
+# This value has some meaning to someone
+foo = bar
+# Make sure to add this when you need it
+trace = false
+logging = true
+; This is a comment as well
+# so we need to track all of them
+; and many could be between things
+
+[NEW SECTION]
+# Another comment
+multi-line =
+	value01
+	value02
+	value03
+closing = 0
+# Trailing comment
+
+```

commented_configparser-2.0.0/README.md

@@ -0,0 +1,107 @@
+[![Python 3.8 | 3.9 | 3.10 | 3.11 | 3.12 | 3.13](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/downloads)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Preocts/commented-configparser/main.svg)](https://results.pre-commit.ci/latest/github/Preocts/commented-configparser/main)
+[![Python tests](https://github.com/Preocts/commented-configparser/actions/workflows/python-tests.yml/badge.svg?branch=main)](https://github.com/Preocts/commented-configparser/actions/workflows/python-tests.yml)
+
+# commented-configparser
+
+A custom ConfigParser class that preserves comments and option casing when writing loaded config out.
+
+This library gives you a custom class of the standard library's `configparser.ConfigParger` which will preserve the comments of a loaded config file when writing that file back out.
+
+---
+
+## Install via pip
+
+From pypi:
+
+```bash
+python -m pip install commented-configparser
+```
+
+From github:
+
+```bash
+python -m pip install commented-configparser@git+https://github.com/Preocts/commented-configparser@x.x.x
+```
+
+**Note:** Replace `x.x.x` with the desired tag or branch.
+
+---
+
+## Example use
+
+```py
+from commentedconfigparser import CommentedConfigParser
+
+# Load the config like normal
+config = CommentedConfigParser()
+config.read("myconfig.ini")
+
+# Use the config like normal
+...
+
+# Update the config like normal
+...
+
+# Save the config back to the file
+with open("myconfig.ini", "w") as savefile:
+    config.write(savefile)
+```
+
+## Results
+
+We favor the line spacing choices of the `ConfigParser` class so the input format may not be preserved completely. However, the comments will be preserved.
+
+### Before
+
+```ini
+# Welcome to our config
+[DEFAULT]
+# This value has some meaning to someone
+foo=bar
+# Make sure to add this when you need it
+trace=false
+logging=true
+; This is a comment as well
+
+    # so we need to track all of them
+
+	; and many could be between things
+[NEW SECTION]
+# Another comment
+multi-line=
+	value01
+	value02
+	value03
+closing=0
+# Trailing comment
+
+```
+
+### After
+
+```ini
+# Welcome to our config
+[DEFAULT]
+# This value has some meaning to someone
+foo = bar
+# Make sure to add this when you need it
+trace = false
+logging = true
+; This is a comment as well
+# so we need to track all of them
+; and many could be between things
+
+[NEW SECTION]
+# Another comment
+multi-line =
+	value01
+	value02
+	value03
+closing = 0
+# Trailing comment
+
+```