coauthor 0.0.5__tar.gz

coauthor-0.0.5/.bumpversion.toml

@@ -0,0 +1,29 @@
+[tool.bumpversion]
+current_version = "0.0.5"
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
+serialize = ["{major}.{minor}.{patch}"]
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+ignore_missing_version = false
+ignore_missing_files = false
+tag = false
+sign_tags = false
+tag_name = "v{new_version}"
+tag_message = "Bump version: {current_version} → {new_version}"
+allow_dirty = false
+commit = false
+message = "Bump version: {current_version} → {new_version}"
+commit_args = ""
+setup_hooks = []
+pre_commit_hooks = []
+post_commit_hooks = []
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+
+[[tool.bumpversion.files]]
+filename = "src/coauthor/__init__.py"
+
+[[tool.bumpversion.files]]
+filename = "docs/conf.py"

coauthor-0.0.5/.coauthor/templates/coauthor/ai-file-update/system.md

@@ -0,0 +1,83 @@
+# Python Co-Author
+
+## IDENTITY AND PURPOSE
+
+You are a co-author of Python files tasked with enhancing, completing and
+refining them based on specific embedded instructions.
+
+## GOAL
+
+Effectively process the Python file by understanding and implementing
+the instructions provided. Achieve this by following these guidelines:
+
+## STEPS
+
+1. **Evaluation**:
+    - Thoroughly read the Python file received as input for comprehensive
+    understanding.
+
+2. **Instruction Identification**:
+    - Locate all co-author instructions contained between parentheses,
+    prefixed
+    with `ai:` (e.g., `(ai: modify this sentence...)`) or `@ai:`.
+
+3. **Instruction Interpretation**:
+    - Comprehend each instruction in the context of the given Python file
+    content.
+    Differentiate between localized instructions and those applicable to the
+    entire document.
+4. **Python Guidelines**:
+    - **Pytest**: The Python project used Pytest so if asked for a test, you should
+    assume a Pytest test. An example test is:
+
+    ```python
+    def test_ping():
+        test_content = "ping"
+        mocked_open = mock_open(read_data=test_content)
+
+        # Create a mock logger
+        mock_logger = mock.Mock()
+
+        with mock.patch("builtins.open", mocked_open):
+            # Call the pong function with a mock path and mock logger
+            pong("mock_path", config=None, logger=mock_logger)
+
+        # Check if the file content was updated to 'pong'
+        # Reconfigure the mocked_open to check the write call
+        mocked_open().write.assert_called_once_with("pong")
+
+        # Ensure logger was called with appropriate messages
+        mock_logger.info.assert_any_call("Running the pong file processor" + "mock_path")
+        mock_logger.info.assert_any_call('Updating mock_path to "pong"')
+    ```
+    - Python methods in the project often utilize `logger` and `config` parameters, here is an example of that
+        ```python
+        def test_get_config_not_found_with_logger():
+            logger = Logger(__name__)
+            config = get_config(logger=logger, config_filename="non-existing-file.yml", search_dir="/tmp")
+            assert config != None
+        ```
+5. **File Modification**:
+    - Execute changes to the File document as per the instructions,
+    ensuring
+    improvements, clarification, corrections, and optimization.
+
+6. **Output Structuring**:
+    - Finalize the file by removing all instructional cues. - Deliver a
+    coherent and clean Python file document that is easily readable and
+    effective.
+
+
+## OUTPUT INSTRUCTIONS
+
+- The finalized document should not contain any of the instructional
+    annotations.
+- Produce a pristine Python file content, adhering strictly to the original
+    content integrity while incorporating instructed changes.
+- Don't return the code as a Markdown code block starting with ```python
+and ending with ```. Only return valid Python code. Your response should be
+valid Python code.
+
+## INPUT
+
+Receive a Python file featuring embedded instructions for processing.

coauthor-0.0.5/.coauthor.yml

@@ -0,0 +1,25 @@
+---
+profile: python
+jinja:
+  search_path: .coauthor/templates
+  custom_delimiters:
+    block_start_string: "{{%"
+    block_end_string: "%}}"
+    variable_start_string: "{{{"
+    variable_end_string: "}}}"
+agent:
+workflows:
+  - name: coauthor
+    watch:
+      filesystem:
+        paths:
+          - src
+          - tests
+    tasks:
+      - id: ai-file-update
+        type: process_file_with_openai_agent
+        path_patterns:
+          - .*\.py$
+        content_patterns:
+          - .*\(ai:.*?\).*
+          - ".*@ai:.*"

coauthor-0.0.5/.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10
+  reviewers:
+  - dciborow
+  allow:
+  - dependency-type: direct
+  - dependency-type: indirect
+  commit-message:
+    prefix: "fix: "
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  commit-message:
+    prefix: "fix: "

coauthor-0.0.5/.github/template-sync.yml

@@ -0,0 +1,21 @@
+files:
+  - ".gitignore"  # include
+  - ".github"
+  - ".vscode"
+  - "tests/conftest.py"
+  - ".flake8"
+  - ".pre-commit-config.yml"
+  - ".pypirc"
+  - "docs"
+  - "src/README.md"
+  - "CODE_OF_CONDUCT.md"
+  - "LICENSE"
+  - "README.md"
+  - "SECURITY.md"
+  - "SUPPORT.md"
+  - "pyproject.toml"
+
+  - "!.github/workflows/template-sync.yml"
+  - "!.github/template-sync.yml"
+  - "!src/python_project"
+  - "!tests/test_methods.py"

coauthor-0.0.5/.github/workflows/CI.yml

@@ -0,0 +1,21 @@
+name: Python CI
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  release:
+    types: [created]    
+  workflow_dispatch:
+
+jobs:
+  validation:
+    uses: microsoft/action-python/.github/workflows/validation.yml@0.6.4
+    with:
+      workdir: '.'
+
+  publish:
+    uses: microsoft/action-python/.github/workflows/publish.yml@0.6.4
+    secrets:
+      PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      TEST_PYPI_PASSWORD: ${{ secrets.TEST_PYPI_PASSWORD  }}

coauthor-0.0.5/.github/workflows/publish.yml

@@ -0,0 +1,10 @@
+name: Python Publish Workflow
+on:
+  workflow_call:
+
+jobs:
+  publish:
+    uses: microsoft/action-python/.github/workflows/publish.yml@0.6.4
+    secrets:
+      PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      TEST_PYPI_PASSWORD: ${{ secrets.TEST_PYPI_PASSWORD  }}

coauthor-0.0.5/.github/workflows/schedule-update-actions.yml

@@ -0,0 +1,25 @@
+name: GitHub Actions Version Updater
+
+# Controls when the action will run.
+on:
+  workflow_dispatch:
+  schedule:
+    # Automatically run on every Sunday
+    - cron:  '0 0 * * 0'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3.5.2
+        with:
+          # [Required] Access token with `workflow` scope.
+          token: ${{ secrets.PAT }}
+
+      - name: Run GitHub Actions Version Updater
+        uses: saadmk11/github-actions-version-updater@v0.7.4
+        with:
+          # [Required] Access token with `workflow` scope.
+          token: ${{ secrets.PAT }}
+          pull_request_title: "ci: Update GitHub Actions to Latest Version"

coauthor-0.0.5/.github/workflows/semantic-pr-check.yml

@@ -0,0 +1,17 @@
+name: "Semantic PR Check"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5.2.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

coauthor-0.0.5/.github/workflows/sphinx.yml

@@ -0,0 +1,18 @@
+name: Deploy Sphinx documentation to Pages
+
+on:
+  push:
+    branches: [main] # branch to trigger deployment
+
+jobs:
+  pages:
+    runs-on: ubuntu-20.04
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - id: deployment
+      uses: sphinx-notes/pages@v3

coauthor-0.0.5/.github/workflows/template-sync.yml

@@ -0,0 +1,12 @@
+name: Template Sync
+on:
+  workflow_dispatch:
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3.5.2 # important!
+      - uses: euphoricsystems/action-sync-template-repository@v2.5.1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          dry-run: true

coauthor-0.0.5/.gitignore

@@ -0,0 +1,130 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+coverage_html
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

coauthor-0.0.5/.gitlab-ci.yml

@@ -0,0 +1,175 @@
+---
+stages:
+  # - lint
+  - test
+  - build
+  - release
+  - deploy
+  - publish
+
+variables:
+  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+  CI_PYTHON_VERSION: "3.11"
+
+default:
+  image: python:$CI_PYTHON_VERSION
+
+before_script:
+  - python --version
+  - pip install --upgrade pip
+
+# .linters:
+#   stage: lint
+#   script:
+#     - pip install . pre-commit mypy==1.13.0 -r tests/requirements.txt
+#     - mypy src/ tests/
+
+# .lint:
+#   extends: .linters
+#   tags:
+#     - docker
+#   only:
+#     - master
+
+.release-base:
+  # Abstract base job for "release" jobs.
+  # Extending jobs must define the following variables:
+  # - PYPI_OIDC_AUD: Audience for the ID token that GitLab
+  #   issues to the pipeline job
+  # - PYPI_OIDC_URL: PyPI endpoint for retrieving a publish
+  #   token with GitLab’s ID token
+  # - UV_PUBLISH_URL: PyPI endpoint for the actual upload
+  stage: deploy
+  # id_tokens:
+  #   PYPI_ID_TOKEN:
+  #     aud: "$PYPI_OIDC_AUD"
+  # script:
+  #   # Use the GitLab ID token to retrieve an API token from PyPI
+  #   - >-
+  #     resp="$(curl -X POST "${PYPI_OIDC_URL}" -d "{\"token\":\"${PYPI_ID_TOKEN}\"}")"
+  #   # Parse the response and extract the token
+  #   - echo $resp > pypi_oidc_response.json
+  #   # - >-
+  #   #   publish_token="$(python -c "import json; print(json.load('${resp}')['token'])")"
+  #   # # Upload the files from "dist/"
+  #   # - export FLIT_PASSWORD=$publish_token
+  #   # - 'echo "FLIT_USERNAME: $FLIT_USERNAME, FLIT_PASSWORD: $FLIT_PASSWORD"'
+  #   # - flit publish
+  #   # Print the link to PyPI so we can quickly go there to verify the result:
+  #   # - 'version="$(uv run --with hatch-vcs hatchling version)"'
+  #   # - 'echo -e "\033[34;1mPackage on PyPI:\033[0m ${CI_ENVIRONMENT_URL}${version}/"'
+  variables:
+    FLIT_USERNAME: onknows
+  # artifacts:
+  #   paths:
+  #     - pypi_oidc_response.json
+
+prepare:
+  stage: build
+  script:
+    - |
+      C2_VERSION=$(grep 'version =' pyproject.toml | awk -F '"' '{print $2}')
+    - 'echo "C2_VERSION: $C2_VERSION"'
+    - |
+      echo "C2_VERSION=$C2_VERSION" >> variables.env
+  artifacts:
+    reports:
+      dotenv: variables.env
+
+build:
+  stage: build
+  script:
+    - python3 -m pip install flit
+    - flit build
+  artifacts:
+    paths:
+      - dist/
+
+release-test:
+  extends: ".release-base"
+  rules:
+    # Only run if it's a pipeline for the default branch or a tag:
+    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_TAG"
+  script:
+    - python3 -m pip install flit
+    - flit build
+    - flit publish
+  environment:
+    name: release-test
+    url: https://test.pypi.org/project/coauthor/
+  variables:
+    PYPI_OIDC_AUD: testpypi
+    PYPI_OIDC_URL: https://test.pypi.org/_/oidc/mint-token
+    FLIT_INDEX_URL: https://test.pypi.org/legacy/
+    FLIT_USERNAME: __token__
+
+test:
+  stage: test
+  services:
+    - docker:dind
+  script:
+    - git config --global user.email "you@example.com"
+    - git config --global user.name "Your Name"
+    - pip install . -r tests/requirements.txt
+    - pytest --cov
+  coverage: '/TOTAL\s+\d+\s+\d+\s+\d+\s+\d+\s+(\d+(?:\.\d+)?)\%$/'
+  # matrix:
+  #   # - PYTHON_VERSION: 3.9 OS: "ubuntu"
+  #   - PYTHON_VERSION: "3.10 OS: 'ubuntu'"
+  #   # - PYTHON_VERSION: 3.11 OS: "ubuntu"
+  #   # - PYTHON_VERSION: 3.12 OS: "ubuntu"
+  #   # - PYTHON_VERSION: 3.13 OS: "ubuntu"
+  #   # - PYTHON_VERSION: 3.14-dev OS: "ubuntu"
+  # parallel: 6
+  allow_failure: true
+  artifacts:
+    paths:
+      - coverage.xml
+  only:
+    - master
+    - tags
+# coverage_report:
+#   stage: test
+#   script:
+#     - if [ "$CI_COMMIT_BRANCH" == "master" ] && [ "$PYTHON_VERSION" == "3.11" ] && [ "$OS" == "ubuntu" ]; then
+#       curl -s https://codecov.io/bash | bash;
+#       fi
+
+# all-good:
+#   stage: deploy
+#   script:
+#     - echo "Great success!"
+#   when: on_success
+
+# # publish:
+# #   stage: publish
+# #   # variables:
+# #   #   TWINE_USERNAME: "__token__"
+# #   #   TWINE_PASSWORD: "$PYPI_TOKEN"
+# #   script:
+# #     - python3 -m pip install flit
+# #     # - pip install .
+# #     - flit build
+# #     - flit publish
+# #   # only:  # TODO enable
+# #   #   - tags
+
+gitlab-release:
+  stage: release
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  needs: [prepare]
+  before_script: []
+  script:
+    - echo "Create Coauthor release $C2_VERSION"
+  release:
+    name: Coauthor $C2_VERSION
+    description: "./CHANGELOG.md"
+    tag_name: $C2_VERSION
+    ref: $CI_COMMIT_SHA
+  when: manual
+  only:
+    - master
+# assets:
+#   links:
+#     - name: coauthor
+#       url: https://galaxy.ansible.com/$C2_NAMESPACE/$C2_NAME

coauthor-0.0.5/.pre-commit-config.yaml

@@ -0,0 +1,60 @@
+ci:
+  autoupdate_commit_msg: "chore: update pre-commit hooks"
+  autofix_commit_msg: "style: pre-commit fixes"
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        args: ["-a", "from __future__ import annotations"]
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.0
+    hooks:
+      - id: pyupgrade
+        args: [--py37-plus]
+
+  - repo: https://github.com/hadialqattan/pycln
+    rev: v1.2.5
+    hooks:
+      - id: pycln
+        args: [--config=pyproject.toml]
+        stages: [manual]
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.1.0
+    hooks:
+      - id: codespell
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.9.0
+    hooks:
+      - id: python-check-blanket-noqa
+      - id: python-check-blanket-type-ignore
+      - id: python-no-log-warn
+      - id: python-no-eval
+      - id: python-use-type-annotations
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+
+  - repo: https://github.com/mgedmin/check-manifest
+    rev: "0.47"
+    hooks:
+      - id: check-manifest
+        stages: [manual]

coauthor-0.0.5/.pypirc

@@ -0,0 +1,10 @@
+[distutils]
+index-servers =
+    pypi
+    testpypi
+
+[pypi]
+repository = https://upload.pypi.org/legacy/
+
+[testpypi]
+repository = https://test.pypi.org/legacy/

coauthor-0.0.5/.readthedocs.yaml

@@ -0,0 +1,14 @@
+---
+version: 2
+
+build:
+   os: "ubuntu-lts-latest"
+   tools:
+      python: "3.11"
+
+sphinx:
+   fail_on_warning: true
+
+python:
+   install:
+      - requirements: docs/requirements.txt