coauthor 0.1.3__tar.gz

coauthor-0.1.3/.bumpversion.toml

@@ -0,0 +1,29 @@
+[tool.bumpversion]
+current_version = "0.1.3"
+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.1.3/.coauthor/templates/coauthor/python/system.md

@@ -0,0 +1,83 @@
+# Python Coauthor
+
+## 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.1.3/.coauthor/templates/coauthor/python/user.md

@@ -0,0 +1 @@
+{{ task['path-modify-event'] | include_file_content }}

coauthor-0.1.3/.coauthor/templates/coauthor-doc/system.md

@@ -0,0 +1,40 @@
+# Python Coauthor
+
+## IDENTITY AND PURPOSE
+
+You are a co-author of documentation in Markdown documentation 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 Markdown 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 Markdown file content. Differentiate between localized
+    instructions and those applicable to the entire document.
+4. **Output Structuring**:  Finalize the file by removing all instructional
+    cues. Deliver a coherent and clean Markdown file document that is easily
+    readable and effective.
+5. **Tips and Suggestions**: Review the file for additional improvements,
+   additions and fixes and provide tips and suggestions as a hidden comment
+   between a line that starts with `<!--` and a line that ends with `-->`.
+
+## OUTPUT INSTRUCTIONS
+
+- The finalized document should not contain any of the instructional
+  annotations.
+- Produce a pristine Markdown file content, adhering strictly to the original
+  content integrity while incorporating instructed changes.
+- Only return valid Python code. Your response should be valid Markdown code.
+
+## INPUT
+
+Receive a Markdown file featuring embedded instructions for processing.

coauthor-0.1.3/.coauthor/templates/coauthor-doc/user/context/file.md

@@ -0,0 +1,6 @@
+# Context
+
+File content: :{{task['frontmatter-item']['file'] }}
+Content:
+
+{{task['frontmatter-item']['file'] | include_file_content }}

coauthor-0.1.3/.coauthor/templates/coauthor-doc/user/context/url.md

@@ -0,0 +1,6 @@
+# Context
+
+Content from URL: {{task['frontmatter-item']['url'] }}
+Content:
+
+{{task['frontmatter-item']['url'] | get_url }}

coauthor-0.1.3/.coauthor/templates/coauthor-doc/user/context.md

@@ -0,0 +1,9 @@
+{%- if 'url' in task['frontmatter-item'] -%}
+{%- include 'context/url.md' -%}
+{%- endif -%}
+{%- if 'file' in task['frontmatter-item'] -%}
+{%- include 'context/file.md' -%}
+{%- endif -%}
+{%- if 'diff' in task['frontmatter-item'] -%}
+{%- include 'context/diff.md' -%}
+{%- endif -%}

coauthor-0.1.3/.coauthor/templates/coauthor-doc/user.md

@@ -0,0 +1 @@
+{{ task['path-modify-event'] | include_file_content }}

coauthor-0.1.3/.coauthor.yml

@@ -0,0 +1,100 @@
+---
+name: coauthor
+type: Python
+description: Coauthor AI Agent for working on code and documentation
+jinja:
+  search_path: .coauthor/templates
+  # custom_delimiters:
+  #   block_start_string: "{{%"
+  #   block_end_string: "%}}"
+  #   variable_start_string: "{{"
+  #   variable_end_string: "}}"
+agent:
+  # model: x-ai/grok-4
+  model: openai/gpt-5.2-pro
+  api_key_var: OPENAI_API_KEY
+  api_url_var: OPENAI_API_URL
+tool_environment: |
+  source ~/.bashrc
+  source ~/.virtualenv/c2d_ai/bin/activate
+file-watcher:
+  ignore-folders:
+    - docs/_build
+    - __pycache__
+    - src/coauthor/profiles # config.yml contain @ai:
+workflows:
+  - name: coauthor
+    path_patterns:
+      - .*\.py$
+      - .*\.yml$
+    content_patterns:
+      - ".*@ai:.*"
+    watch:
+      filesystem:
+        paths:
+          - src
+          - tests
+    tasks:
+      - id: python
+        type: ai
+      - id: write-file
+        type: write_file
+        content: >-
+          {{ config | get_task_attribute('python', 'response') }}
+  - name: coauthor-doc
+    path_patterns:
+      - .*\.md$
+    content_patterns:
+      - ".*@ai:.*"
+    watch:
+      filesystem:
+        paths:
+          - docs
+    tasks:
+      - id: docs
+        type: ai
+        messages:
+          - file: coauthor-doc/user/context.md
+            frontmatter: coauthor/context
+      - id: write-file
+        type: write_file
+        content: >-
+          {{ config | get_task_attribute('docs', 'response') }}
+projects:
+  - name: jira
+    type: jira
+    description: Coauthor tickets in JIRA
+    profile: jira
+    profile_args:
+      agent:
+        # model: x-ai/grok-4
+        model: openai/gpt-5.2-pro
+        api_key_var: OPENAI_API_KEY
+        api_url_var: OPENAI_API_URL
+      content_patterns:
+        - '\[~coauthor\]'
+      watch:
+        jira:
+          # url: https://www.example.com/jira/
+          query: >-
+            project = C2 AND component = COAUTHOR
+            AND (updated >= -0.35h OR created >= -0.35h)
+          sleep: 10
+      # content_patterns:
+      #   - "@ai: "
+      # watch:
+      #   jira:
+      #     # url: https://www.example.com/jira/
+      #     comments:
+      #       - query: >-
+      #           project = C2 AND component = COAUTHOR
+      #           AND (updated >= -0.35h OR created >= -0.35h)
+      #         # AND labels in (coauthor-comments)
+      #         add_labels: [coauthor-comments]
+      #         # remove_labels: [ai-comment]
+      #     tickets:
+      #       - query: project = C2 AND component = COAUTHOR AND labels in (rfai)
+      #         add_labels: [rfr]
+      #         remove_labels: [rfai]
+      #         assign_to_creator: false
+      #     sleep: 10

coauthor-0.1.3/.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.1.3/.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.1.3/.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.1.3/.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.1.3/.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.1.3/.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.1.3/.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.1.3/.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.1.3/.gitignore

@@ -0,0 +1,133 @@
+# 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
+.coauthor_dump.yml

coauthor-0.1.3/.gitlab-ci.yml

@@ -0,0 +1,107 @@
+---
+stages:
+  # - lint
+  - test
+  - build
+  - release
+
+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
+
+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/
+
+pypi-publish:
+  stage: release
+  script:
+    - python3 -m pip install flit
+    - flit build
+    - flit publish
+  # environment: # require approval
+  #   name: release
+  #   url: https://pypi.org/project/coauthor
+  # variables:
+  #   # FLIT_INDEX_URL: https://test.pypi.org/legacy/
+  #   FLIT_USERNAME: __token__
+  only:
+    - tags
+
+test:
+  stage: test
+  parallel:
+    matrix:
+      - PY: ["3.10", "3.11"]
+        # DEPS_VERSION: ["min_deps_version", "latest_deps_version"]
+  image: "python:$PY"
+  # 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 src --cov-fail-under 100
+  coverage: '/TOTAL\s+\d+\s+\d+\s+\d+\s+\d+\s+(\d+(?:\.\d+)?)\%$/'
+  allow_failure: true
+  artifacts:
+    paths:
+      - coverage.xml
+      - coverage_html
+
+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