codext 1.15.11__tar.gz → 1.16.0__tar.gz

codext-1.16.0/.github/ISSUE_TEMPLATE/add-encoding.yml

@@ -0,0 +1,21 @@
+name: Add new encoding
+description: Propose a new encoding to be added
+title: "Add new encoding: [codec]"
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe the encoding, its purpose, and how it works
+      placeholder: Provide a clear and concise description
+    validations:
+      required: true
+  - type: input
+    id: reference
+    attributes:
+      label: Reference
+      description: Provide a reference URL for the encoding
+      placeholder: https://
+    validations:
+      required: false

codext-1.16.0/.github/copilot-instructions.md

@@ -0,0 +1,81 @@
+# Copilot Instructions — Enhancements Only
+
+## Scope
+This repository focuses on **adding new encoding/decoding schemes only**.
+
+Copilot MUST:
+- Propose **new codecs only**
+- Avoid refactoring unrelated code
+- Avoid dependency changes unless strictly required for the codec
+- Avoid stylistic or formatting changes
+
+## Context
+This project extends Python's codecs with many encoding/decoding schemes and a CLI tool.
+It already includes a wide variety of bases, ciphers, compression, and niche encodings.
+
+## Enhancement Guidelines
+When adding a new encoding, follow the guideline in the documentation at `docs/pages/howto.md`.
+
+
+## Implementation Constraints
+
+- Pure Python preferred
+- No heavy dependencies
+- Deterministic transformations only
+- Reversible encoding required unless explicitly documented
+
+## Testing
+
+Every new codec:
+- SHOULD include a list of `__examples__` that tells the automated tests what encoding/decoding transformations need to be verified ; it this cannot be made, unit tests (encode/decode roundtrip) SHALL be provided in `tests/test_manual.py`
+- Edge cases (empty input, binary data if applicable), either in the `__examples__` list or in the explicit tests in `tests/test_manual.py`
+
+## Documentation
+
+Each codec SHALL comply with the following structure:
+
+    ```python
+    # -*- coding: UTF-8 -*-
+    """{{codec_long_name}} Codec - {{codec_short_name}} content encoding.
+
+    {{codec_description}}
+
+    This codec:
+    - en/decodes strings from str to str
+    - en/decodes strings from bytes to bytes
+    - decodes file content to str (read)
+    - encodes file content from str to bytes (write)
+
+    Reference: {{codec_source_hyperlink}}
+    """
+    from ..__common__ import *
+
+
+    __examples__ = {<<dictionary of examples with, as keys, a special format detailed hereafter and, as values, a dictionary mapping source to destination values (see sectino _Self-generated tests_)>>}
+    <<optional list of valid codec names to be used with the guessing mode (see _Codec names for the guessing mode_), in format "__guess__ = [...]">>]
+
+
+    <<constants here, including ENCMAP if the codec is a simple mapping (see section _Case 2: Encoding map_)>>
+    <<functions here, if the codec requires some additional logic, i.e. when it is not a mapping (see section _Case 1: Generic encoding definition_)>>
+
+
+    <<put the right add function (see section _Which `add` function ?_) here with its relevant parameters (see section _Generic arguments_)>>
+    ```
+
+In this template, `{{ ... }}` enclosures indicate codec's properties and `<< ... >>``enclosures indicate placeholder actions referring to steps from the documentation about how to make a codec at `docs/pages/howto.md`.
+
+## Output Format (IMPORTANT)
+
+When asked to add a codec, Copilot should:
+1. Briefly justify the encoding (1–2 lines)
+2. Provide full implementation (according to section _Adding a new codec to `codext`_ of the documentation at `docs/pages/howto.md`)
+3. Provide tests (according to section _Self-generated tests_)
+4. Add it to the `README.md` of the repository
+5. Propose the update of the documentation (under the relevant page for the category of codec)
+
+## Explicit Non-Goals
+
+- No refactoring
+- No performance optimization passes
+- No linting-only changes
+- No CI/CD changes

codext-1.16.0/.github/prompts/add_codec.prompt.md

@@ -0,0 +1,17 @@
+Add a new encoding scheme to this repository.
+
+Constraints:
+- Follow copilot-instructions.md strictly
+- Do not modify unrelated code
+- Use existing codec patterns
+
+Task:
+Add encoding: {{ENCODING_NAME}}
+
+Requirements:
+- Implement according to ADDING_CODECS.md guideline
+- Add tests if needed (if `__examples__` cannot be consistently defined)
+- Add minimal documentation (in the relevant category page under `docs/pages`)
+
+Reference:
+{{LINK_OR_DESCRIPTION}}

codext-1.16.0/.github/pull_request_template.md

@@ -0,0 +1,8 @@
+## Checklist
+- [ ] No unrelated changes
+- [ ] Codec is new (not already implemented)
+- [ ] Tests included (if cannot be automated with `tests/test_generated`)
+- [ ] Documentation (included in the right page in `docs/pages/enc`)
+
+## Description
+Explain the encoding and its source.

{codext-1.15.11 → codext-1.16.0}/.github/workflows/python-package.yml

@@ -3,27 +3,41 @@
 
 name: build
 
-env:
-  package: codext
-
 on:
   push:
     branches: [ "main" ]
   pull_request:
     branches: [ "main" ]
 
+permissions:
+  id-token: write
+  contents: read
+
 jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    outputs:
+      package: ${{ steps.pkg.outputs.package }}
+    steps:
+      - name: Compute package name from the repository's
+        id: pkg
+        run: |
+          name="${GITHUB_REPOSITORY##*/}"
+          echo "package=${name#python-}" >> $GITHUB_OUTPUT
   build:
+    needs: prepare
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    env:
+      package: ${{ needs.prepare.outputs.package }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v5
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install ${{ env.package }}
@@ -37,16 +51,23 @@ jobs:
       run: |
         pytest --cov=$package
   coverage:
-    needs: build
+    needs: [prepare, build]
+    permissions:
+      contents: write
     runs-on: ubuntu-latest
     env:
       cov_badge_path: docs/coverage.svg
+      package: ${{ needs.prepare.outputs.package }}
+      python_version: "3.13"
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+    - uses: actions/checkout@v5
       with:
-        python-version: "3.13"
+        fetch-depth: 0
+        ref: ${{ github.head_ref || github.ref_name }}
+    - name: Set up Python ${{ env.python_version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ env.python_version }}
     - name: Install ${{ env.package }}
       run: |
         python -m pip install --upgrade pip
@@ -59,32 +80,30 @@ jobs:
         pytest --cov=$package --cov-report=xml
         genbadge coverage -i coverage.xml -o $cov_badge_path
     - name: Verify Changed files
-      uses: tj-actions/verify-changed-files@v17
+      uses: tj-actions/verify-changed-files@v20
       id: changed_files
       with:
         files: ${{ env.cov_badge_path }}
-    - name: Commit files
+    - name: Push coverage badge
       if: steps.changed_files.outputs.files_changed == 'true'
       run: |
         git config --local user.email "github-actions[bot]@users.noreply.github.com"
         git config --local user.name "github-actions[bot]"
+        git fetch origin
+        git checkout coverage-badge || git checkout -b coverage-badge
         git add $cov_badge_path
-        git commit -m "Updated coverage.svg"
-    - name: Push changes
-      if: steps.changed_files.outputs.files_changed == 'true'
-      uses: ad-m/github-push-action@master
-      with:
-        github_token: ${{ secrets.github_token }}
-        branch: ${{ github.ref }}
+        git diff --cached --quiet && exit 0
+        git commit -m "Update coverage badge"
+        git push origin coverage-badge --force
   deploy:
     runs-on: ubuntu-latest
-    needs: coverage
+    needs: [prepare, coverage]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v5
       with:
         fetch-depth: 0
     - name: Check for version change
-      uses: dorny/paths-filter@v2
+      uses: dorny/paths-filter@v4
       id: filter
       with:
         filters: |
@@ -97,12 +116,8 @@ jobs:
         awk '{if (match($0,"## Supporters")) exit; print}' README.md > README
         mv -f README README.md
     - if: steps.filter.outputs.version == 'true'
-      name: Build ${{ env.package }} package
+      name: Build ${{ needs.prepare.outputs.package }} package
       run: python3 -m pip install --upgrade build && python3 -m build
     - if: steps.filter.outputs.version == 'true'
-      name: Upload ${{ env.package }} to PyPi
+      name: Publish to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        password: ${{ secrets.PYPI_API_TOKEN }}
-        verbose: true
-        verify_metadata: false