commented-configparser 2.1.0__tar.gz → 3.0.0__tar.gz

commented_configparser-3.0.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,61 @@
+name: "Publish Python distribution to PyPI"
+# Uses:
+# https://github.com/actions/setup-python : a26af69be951a213d495a4c3e4e4022e16d87065
+# https://github.com/actions/checkout : 11bd71901bbe5b1630ceea73d27597364c9af683
+# https://github.com/actions/download-artifact : d3f86a106a0bac45b974a628896c90dbdf5c8093
+# https://github.com/actions/upload-artifact : ea165f8d65b6e75b540449e92b4886f43607fa02
+# https://github.com/actions/pypa/gh-action-pypi-publish : 76f52bc884231f62b9a034ebfe128415bbaabdfc
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: "Build package"
+    runs-on: "ubuntu-latest"
+    outputs:
+      artifact-id: "${{ steps.upload-artifact.outputs.artifact-id }}"
+
+    steps:
+      - uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
+        with:
+          persist-credentials: false
+
+      - name: "Set up Python"
+        uses: "actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065"
+        with:
+          python-version: "3.12"
+
+      - name: "Build the package"
+        run: "python -m pip install nox; nox -s build"
+
+      - name: "Store the distribution packages"
+        id: "upload-artifact"
+        uses: "actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02"
+        with:
+          path: "./dist"
+
+  publish-to-pypi:
+    name: "Publish Python Distribution to PyPI"
+    needs: ["build"]
+    runs-on: "ubuntu-latest"
+    environment:
+      name: "pypi"
+      url: "https://pypi.org/project/commented-configparser/"
+    permissions:
+      id-token: "write"
+
+    steps:
+      - name: "Download all the dists"
+        uses: "actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093"
+        with:
+          artifact-ids: "${{ needs.build.outputs.artifact-id }}"
+          path: "./dist"
+          merge-multiple: true
+
+      - name: "Publish distribution to PyPI"
+        uses: "pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc"
+        with:
+          repository-url: "https://upload.pypi.org/legacy/"
+          verbose: true

commented_configparser-3.0.0/.github/workflows/pypi-test-publish.yml

@@ -0,0 +1,62 @@
+name: "Publish Python distribution to PyPI Test"
+# Uses:
+# https://github.com/actions/setup-python : a26af69be951a213d495a4c3e4e4022e16d87065
+# https://github.com/actions/checkout : 11bd71901bbe5b1630ceea73d27597364c9af683
+# https://github.com/actions/download-artifact : d3f86a106a0bac45b974a628896c90dbdf5c8093
+# https://github.com/actions/upload-artifact : ea165f8d65b6e75b540449e92b4886f43607fa02
+# https://github.com/actions/pypa/gh-action-pypi-publish : 76f52bc884231f62b9a034ebfe128415bbaabdfc
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[a-z]+[0-9]+"
+
+jobs:
+  build:
+    name: "Build package"
+    runs-on: "ubuntu-latest"
+    outputs:
+      artifact-id: "${{ steps.upload-artifact.outputs.artifact-id }}"
+
+    steps:
+      - uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
+        with:
+          persist-credentials: false
+
+      - name: "Set up Python"
+        uses: "actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065"
+        with:
+          python-version: "3.12"
+
+      - name: "Build the package"
+        run: "python -m pip install nox; nox -s build"
+
+      - name: "Store the distribution packages"
+        id: "upload-artifact"
+        uses: "actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02"
+        with:
+          path: "./dist"
+
+  publish-to-pypi:
+    name: "Publish Python Distribution to PyPI"
+    needs: ["build"]
+    runs-on: "ubuntu-latest"
+    environment:
+      name: "testpypi"
+      url: "https://test.pypi.org/project/commented-configparser/"
+    permissions:
+      id-token: "write"
+
+    steps:
+      - name: "Download all the dists"
+        uses: "actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093"
+        with:
+          artifact-ids: "${{ needs.build.outputs.artifact-id }}"
+          path: "./dist"
+          merge-multiple: true
+
+      - name: "Publish distribution to PyPI"
+        uses: "pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc"
+        with:
+          repository-url: "https://test.pypi.org/legacy/"
+          verbose: true

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

@@ -0,0 +1,119 @@
+name: "python tests and coverage"
+# Uses:
+# https://github.com/actions/setup-python : a26af69be951a213d495a4c3e4e4022e16d87065
+# https://github.com/actions/checkout : 11bd71901bbe5b1630ceea73d27597364c9af683
+# https://github.com/actions/download-artifact : d3f86a106a0bac45b974a628896c90dbdf5c8093
+# https://github.com/actions/upload-artifact : ea165f8d65b6e75b540449e92b4886f43607fa02
+
+on:
+  pull_request:
+    branches:
+      - "main"
+  push:
+    branches:
+      - "main"
+
+jobs:
+  settings:
+    runs-on: "ubuntu-latest"
+    name: "Define workflow settings"
+    outputs:
+      default-python-version: "3.12"
+    steps:
+      - name: "Define settings"
+        run: ""
+
+  run-tests-and-coverage:
+    name: "Run pytest with coverage."
+    needs: ["settings"]
+    runs-on: "${{ matrix.os }}"
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - "windows-latest"
+          - "ubuntu-latest"
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+
+    steps:
+      - name: "Repo checkout"
+        uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
+
+      - name: "Set up Python ${{ matrix.python-version }}"
+        uses: "actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065"
+        with:
+          python-version: "${{ matrix.python-version }}"
+          allow-prereleases: true
+
+      - name: "Install nox"
+        run: |
+          python -m pip install --upgrade nox
+
+      - name: "Run tests and coverage via nox"
+        run: |
+          nox --session test -- partial-coverage
+
+      - name: "Save coverage artifact"
+        uses: "actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02"
+        with:
+          name: "coverage-artifact-${{ matrix.os}}-${{ matrix.python-version}}"
+          path: ".coverage.*"
+          retention-days: 1
+          include-hidden-files: true
+
+  coverage-compile:
+    name: "Compile coverage reports."
+    needs: ["settings", "run-tests-and-coverage"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Repo checkout"
+        uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
+
+      - name: "Set up Python"
+        uses: "actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065"
+        with:
+          python-version: "${{ needs.settings.outputs.default-python-version }}"
+
+      - name: "Install nox"
+        run: |
+          python -m pip install --upgrade nox
+
+      - name: "Download coverage artifacts"
+        uses: "actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093"
+        with:
+          pattern: "coverage-artifact-*"
+          merge-multiple: true
+
+      - name: "Compile coverage data, print report"
+        run: |
+          nox --session coverage_combine
+          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
+
+  linting:
+    name: "Check linting and formatting requirements"
+    needs: ["settings"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Repo checkout"
+        uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
+
+      - name: "Set up Python"
+        uses: "actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065"
+        with:
+          python-version: "${{ needs.settings.outputs.default-python-version }}"
+
+      - name: "Install nox"
+        run: |
+          python -m pip install --upgrade nox
+
+      - name: "Run formatters and linters"
+        run: |
+          nox --session lint

{commented_configparser-2.1.0 → commented_configparser-3.0.0}/.gitignore

@@ -1,6 +1,6 @@
 temp_*
 .env
-venv/
+.venv/
 *egg-info/
 .tox/
 .coverage

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

@@ -0,0 +1,11 @@
+ci:
+  autoupdate_schedule: monthly
+exclude: ^.+\.ini$
+repos:
+  # Batch of helpful formatters and patterns
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v5.0.0"
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: mixed-line-ending

commented_configparser-3.0.0/CONTRIBUTING.md

@@ -0,0 +1,111 @@
+# 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.
+
+Be sure to run the expected formatters and linters prior to opening the PR.
+
+### 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
+
+```bash
+git clone https://github.com/Preocts/commented-configparser
+
+cd commented-configparser
+```
+
+### [Install nox](https://nox.thea.codes/en/stable/index.html)
+
+It is recommended to use a tool such as `pipx` or `uvx` to install nox. nox is
+needed to run the provided sessions for developer setup, linting, tests, and
+dependency management. It is optional, but these instructions will not cover
+manually steps outside of nox.
+
+
+## Nox Sessions
+
+### Developer Install
+
+This builds the `/.venv`, installs the editable
+package, and installs all dependency files.
+
+```bash
+nox -s dev
+```
+
+### Run tests with coverage
+
+```bash
+nox -s test
+```
+
+### Run formatters and linters
+
+```bash
+nox -s lint
+```
+
+### Build dist
+
+```bash
+nox -s build
+```
+
+---
+
+## Updating dependencies
+
+New dependencys can be added to the `requirements-*.txt` 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 `constraints.txt` file.
+
+Once updated following the steps below, the package can be installed if needed.
+
+### Update the generated files with changes
+
+```bash
+nox -s update-deps
+```
+
+### Upgrade all generated dependencies
+
+```bash
+nox -s upgrade-deps
+```

{commented_configparser-2.1.0/src/commented_configparser.egg-info → commented_configparser-3.0.0}/PKG-INFO

@@ -1,52 +1,30 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: commented-configparser
-Version: 2.1.0
-Summary: Custom ConfigParser class that preserves comments in file when writing
+Version: 3.0.0
+Summary: A custom ConfigParser class that preserves comments and most formatting when writing loaded config out.
 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.
-        
+License-Expression: MIT
 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
+Requires-Python: >=3.9
 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"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; 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"
+Dynamic: license-file
 
-[![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)
+[![Python 3.9 | 3.10 | 3.11 | 3.12 | 3.13 | 3.14](https://img.shields.io/badge/Python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-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)
 
@@ -55,9 +33,17 @@ Requires-Dist: nox; extra == "test"
 
 # commented-configparser
 
-A custom ConfigParser class that preserves comments and option casing when writing loaded config out.
+- [Contributing Guide and Developer Setup Guide](./CONTRIBUTING.md)
+- [License: MIT](./LICENSE)
+
+---
+
+A custom ConfigParser class that preserves comments and most formatting 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.
+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.
 
 ---
 
@@ -101,7 +87,11 @@ with open("myconfig.ini", "w") as 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.
+There is the attempt to retain the original format. Known formats that will not
+be preserved:
+
+1. Indents will not be preserved outside of multi-line values
+2. Spacing around assignments will be normalized.
 
 ### Before
 
@@ -120,13 +110,12 @@ logging=true
 	; and many could be between things
 [NEW SECTION]
 # Another comment
-multi-line=
+multiLine=
 	value01
 	value02
 	value03
 closing=0
 # Trailing comment
-
 ```
 
 ### After
@@ -140,16 +129,16 @@ foo = bar
 trace = false
 logging = true
 ; This is a comment as well
+
 # so we need to track all of them
-; and many could be between things
 
+; and many could be between things
 [NEW SECTION]
 # Another comment
-multi-line =
+multiLine =
 	value01
 	value02
 	value03
 closing = 0
 # Trailing comment
-
 ```

{commented_configparser-2.1.0 → commented_configparser-3.0.0}/README.md

@@ -1,4 +1,4 @@
-[![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)
+[![Python 3.9 | 3.10 | 3.11 | 3.12 | 3.13 | 3.14](https://img.shields.io/badge/Python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-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)
 
@@ -7,9 +7,17 @@
 
 # commented-configparser
 
-A custom ConfigParser class that preserves comments and option casing when writing loaded config out.
+- [Contributing Guide and Developer Setup Guide](./CONTRIBUTING.md)
+- [License: MIT](./LICENSE)
 
-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.
+---
+
+A custom ConfigParser class that preserves comments and most formatting 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.
 
 ---
 
@@ -53,7 +61,11 @@ with open("myconfig.ini", "w") as 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.
+There is the attempt to retain the original format. Known formats that will not
+be preserved:
+
+1. Indents will not be preserved outside of multi-line values
+2. Spacing around assignments will be normalized.
 
 ### Before
 
@@ -72,13 +84,12 @@ logging=true
 	; and many could be between things
 [NEW SECTION]
 # Another comment
-multi-line=
+multiLine=
 	value01
 	value02
 	value03
 closing=0
 # Trailing comment
-
 ```
 
 ### After
@@ -92,16 +103,16 @@ foo = bar
 trace = false
 logging = true
 ; This is a comment as well
+
 # so we need to track all of them
-; and many could be between things
 
+; and many could be between things
 [NEW SECTION]
 # Another comment
-multi-line =
+multiLine =
 	value01
 	value02
 	value03
 closing = 0
 # Trailing comment
-
 ```