pycodetags 0.1.0__tar.gz

pycodetags-0.1.0/.github/workflows/build.yml

@@ -0,0 +1,60 @@
+name: Build and Test
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4.1.7
+      with:
+        persist-credentials: false
+    - uses: actions/setup-python@v5.1.1
+      with:
+        python-version: '3.13'
+          # cache: 'pipenv' # caching pipenv dependencies
+    - name: Install uv and pipx
+      run: |
+        pip install uv && pip install pipx
+
+    - name: Install global dependencies
+      run: |
+        pipx install uv && pipx install "coderoller" && \
+        pipx install isort && pipx install black && pipx install bandit && \
+        pipx install pylint && pipx install pre-commit && pipx install poetry && pipx install hatch
+
+    - name: Install Dependencies
+      run: uv sync
+
+    - name: Run make check
+      run: uv run make check
+    - name: Run make publish
+      run: uv run make publish
+    - name: Upload Package
+      uses: actions/upload-artifact@v4.3.6
+      with:
+        name: packages
+        path: dist/
+        if-no-files-found: error
+        retention-days: 1
+
+
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pycodetags
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    # if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    steps:
+    - name: Get packages
+      uses: actions/download-artifact@v4.1.8
+      with:
+        name: packages
+        path: dist/
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@v1.12.4
+    needs: build

pycodetags-0.1.0/.github/workflows/update_plugins_list.yml

@@ -0,0 +1,70 @@
+name: Update Plugin List
+
+on:
+  schedule:
+    # At 00:00 on Sunday.
+    # https://crontab.guru
+    - cron: '0 0 * * 0'
+  workflow_dispatch:
+
+# Set permissions at the job level.
+permissions: {}
+
+jobs:
+  update-plugin-list:
+    if: github.repository_owner == 'matthewdeanmartin'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+
+      - name: requests-cache
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/code-tags-plugin-list/
+          key: plugins-http-cache-${{ github.run_id }} # Can use time based key as well
+          restore-keys: plugins-http-cache-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install packaging requests tabulate[widechars] tqdm requests-cache platformdirs
+
+      - name: Update Plugin List
+        run: python scripts/update_plugins_list.py
+
+      - name: Create Pull Request
+        id: pr
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e
+        with:
+          commit-message: '[automated] Update plugin list'
+          author: 'code tags bot <codetagsbot@users.noreply.github.com>'
+          branch: update-plugin-list/patch
+          delete-branch: true
+          branch-suffix: short-commit-hash
+          title: '[automated] Update plugin list'
+          body: '[automated] Update plugin list'
+          draft: true
+
+      - name: Instruct the maintainers to trigger CI by undrafting the PR
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+          PULL_REQUEST_NUMBER: ${{ steps.pr.outputs.pull-request-number }}
+        run: >-
+          gh pr comment
+          --body 'Please mark the PR as ready for review to trigger PR checks.'
+          --repo '${{ github.repository }}'
+          "$PULL_REQUEST_NUMBER"

pycodetags-0.1.0/.gitignore

@@ -0,0 +1,195 @@
+# 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/
+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
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the enitre vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+/pydocs/

pycodetags-0.1.0/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

pycodetags-0.1.0/.idea/code_tags.iml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/plugins/code_tags_discussion" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/plugins/code_tags_html_templates" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/plugins/code_tags_javascript" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/plugins/code_tags_jira_sync" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/plugins/code_tags_ldap_validation" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/plugins/code_tags_markdown_view" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/plugins/code_tags_remove_done" isTestSource="false" />
+      <excludeFolder url="file://$MODULE_DIR$/.venv" />
+    </content>
+    <orderEntry type="jdk" jdkName="uv (code_tags) (2)" jdkType="Python SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+  <component name="PackageRequirementsSettings">
+    <option name="requirementsPath" value="" />
+  </component>
+  <component name="TestRunnerService">
+    <option name="PROJECT_TEST_RUNNER" value="py.test" />
+  </component>
+</module>

pycodetags-0.1.0/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,7 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="Stylelint" enabled="true" level="ERROR" enabled_by_default="true" />
+  </profile>
+</component>

pycodetags-0.1.0/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,7 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="PROJECT_PROFILE" value="Default" />
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

pycodetags-0.1.0/.idea/misc.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Black">
+    <option name="sdkName" value="Python 3.12 (svcs)" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="uv (code_tags) (2)" project-jdk-type="Python SDK" />
+  <component name="PythonCompatibilityInspectionAdvertiser">
+    <option name="version" value="3" />
+  </component>
+</project>

pycodetags-0.1.0/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/code_tags.iml" filepath="$PROJECT_DIR$/.idea/code_tags.iml" />
+    </modules>
+  </component>
+</project>

pycodetags-0.1.0/.idea/vcs.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

pycodetags-0.1.0/.markdownlintrc

@@ -0,0 +1,36 @@
+{
+  // Enable all markdownlint rules
+  "default": true,
+
+  // Disable line length check
+  "MD013": false,
+
+  // Real English sometimes ends in punct
+  "MD026": false,
+
+  // Pelican doesn't require H1 at top
+  "MD041": false,
+
+  // Set Ordered list item prefix to "ordered" (use 1. 2. 3. not 1. 1. 1.)
+  "MD029": { "style": "ordered" },
+
+  ///list-marker-space - mdformat disagrees
+  "MD030": false,
+
+  // Set list indent level to 4 which Python-Markdown requires
+  "MD007": {
+    "indent": 2
+  },
+  "MD007/ul-indent":{
+    "indent": 2
+  },
+
+  // Code block style
+  "MD046": { "style": "fenced" },
+
+  // Multiple headings with the same title
+  "MD024": { "siblings_only": true }
+
+  // Allow inline HTML
+  //"MD033": false
+}

pycodetags-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,96 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      # each hook takes about 1s to run. These are expensive-ish checks
+      - id: check-added-large-files
+      - id: check-yaml
+      - id: check-builtin-literals
+      - id: check-byte-order-marker
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-toml
+      - id: debug-statements
+      - id: detect-private-key
+      - id: fix-encoding-pragma
+        args: [ --remove ]
+      - id: forbid-new-submodules
+# Too aggressive if you are trying to support old vers!
+#  - repo: https://github.com/asottile/pyupgrade
+#    rev: v3.20.0
+#    hooks:
+#      - id: pyupgrade
+#        args: [ "--py37-plus", "--keep-runtime-typing"]
+  # Buggy? Reports no files change, "FAILURE"
+  #    -   repo: https://github.com/tox-dev/pyproject-fmt
+  #        rev: "0.4.1"
+  #        hooks:
+  #            -   id: pyproject-fmt
+  # works for me, don't know why it is complaining
+  #    -   repo: https://github.com/abravalheri/validate-pyproject
+  #        rev: v0.10.1
+  #        hooks:
+  #            -   id: validate-pyproject
+  - repo: https://github.com/myint/autoflake
+    rev: v2.3.1
+    hooks:
+      - id: autoflake
+        args:
+          - --in-place
+          - --recursive
+          - --expand-star-imports
+          - --remove-all-unused-imports
+          - --remove-duplicate-keys
+          - --remove-unused-variables
+# black is conflicting with something else
+#  - repo: https://github.com/psf/black
+#    rev: 23.12.1
+#    hooks:
+#      - id: black
+#        language_version: python3.10
+  #    -   repo: https://github.com/pycqa/isort
+  #        rev: 5.11.4
+  #        hooks:
+  #            -   id: isort
+  #                name: isort
+  #                args:
+  #                    - --profile black
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.12.0
+    hooks:
+      - id: ruff
+        exclude: ^dead_code/
+        args: [
+          "--config",
+          "pyproject.toml",
+          "--fix",
+        ]
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0  # Use the ref you want to point at
+    hooks:
+      - id: python-use-type-annotations
+      - id: python-no-eval
+      - id: python-no-log-warn
+      - id: text-unicode-replacement-char
+#  - repo: https://github.com/igorshubovych/markdownlint-cli
+#    rev: v0.38.0
+#    hooks:
+#      - id: markdownlint
+#        # '--fix'
+#        args: [ 'content/**/*.md', '--config', '.markdownlintrc' ]
+#  - repo: https://github.com/executablebooks/mdformat
+#    rev: 0.7.17  # Use the ref you want to point at
+#    hooks:
+#      - id: mdformat
+#        # Optionally add plugins
+#        additional_dependencies:
+#          - mdformat-gfm
+#          - mdformat-black
+#  - repo: https://github.com/adamchainz/blacken-docs
+#    rev: 1.19.1
+#    hooks:
+#    -   id: blacken-docs
+#        additional_dependencies:
+#        - black==23.12.1

pycodetags-0.1.0/.pydoctest.json

@@ -0,0 +1,5 @@
+{
+    "include_paths": [ "code_tags/*.py" ],
+    "fail_on_missing_docstring": true,
+    "parser": "google"
+}