panvimwiki 0.4.0__tar.gz → 0.7__tar.gz

{panvimwiki-0.4.0 → panvimwiki-0.7}/.circleci/config.yml

@@ -9,12 +9,12 @@ jobs:
     steps:
       - checkout
 
-      
+
       # - restore_cache:
       #     keys:
       #     - v1-dependencies-{{ checksum "environment.yml" }}
       #     - v1-dependencies-
-      
+
 
       - run:
           name: install dependencies
@@ -27,12 +27,12 @@ jobs:
             conda build conda.recipe --no-test
             conda install --use-local vimwiki_docx
 
-      
+
       # - save_cache:
       #     paths:
       #       - /opt/conda
       #     key: v1-dependencies-{{ checksum "environment.yml" }}
-      
+
 
       - run:
           name: run tests

{panvimwiki-0.4.0 → panvimwiki-0.7}/.coveragerc

@@ -36,5 +36,7 @@ exclude_lines =
     # Don't complain if non-runnable code isn't run:
     if 0:
     if __name__ == .__main__.:
-omit = tests/vim/bundle/*
+omit =
+    tests/vim/bundle/*
+    tests/vim/vimrc
 show_missing = true

panvimwiki-0.7/.editorconfig

@@ -0,0 +1,47 @@
+
+EditorrConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{js,py,html,html5}]
+charset = utf-8
+
+[*.{md,mdpp,diff,vim}]
+trim_trailing_whitespace = false
+
+[{vimrc,gvimrc}]
+trim_trailing_whitespace = false
+
+[*.py]
+indent_style = space
+indent_size = 4
+
+[Makefile]
+indent_style = tab
+
+[*.{json,yml}]
+indent_style = space
+indent_size = 2
+
+[*.{cs}]
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.{json}]
+indent_size = 2
+trim_trailing_whitespace = true
+
+[*.{ps1,psm1,psd1}]
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.{ps1xml,props,xml,yaml}]
+indent_size = 2

panvimwiki-0.7/.github/workflows/ci.yml

@@ -0,0 +1,200 @@
+# GitHub Actions configuration **EXAMPLE**,
+# MODIFY IT ACCORDING TO YOUR NEEDS!
+# Reference: https://docs.github.com/en/actions
+
+name: Test and Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on:
+  push:
+    # Avoid using all the resources/limits available by checking only
+    # relevant branches and tags. Other branches can be checked via PRs.
+    branches: [main]
+    tags: ["v[0-9]*", "[0-9]+.[0-9]+*"] # Match tags that resemble a version
+  pull_request: # Run in every PR
+  workflow_dispatch: # Allow manually triggering the workflow
+  schedule:
+    # Run roughly every 15 days at 00:00 UTC
+    # (useful to check if updates on dependencies break the package)
+    - cron: "0 0 1,16 * *"
+
+permissions:
+  contents: read
+
+concurrency:
+  group: >-
+    ${{ github.workflow }}-${{ github.ref_type }}-
+    ${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    outputs:
+      wheel-distribution: ${{ steps.wheel-distribution.outputs.path }}
+    steps:
+      - uses: actions/checkout@v4
+        with: { fetch-depth: 0 } # deep clone for setuptools-scm
+      - uses: actions/setup-python@v5
+        id: setup-python
+        with: { python-version: "3.11" }
+      - name: Run static analysis and format checkers
+        run: pipx run pre-commit run --all-files --show-diff-on-failure
+      - name: Build package distribution files 📦
+        run: >-
+          pipx run --python '${{ steps.setup-python.outputs.python-path }}'
+          tox -e clean,build
+      - name: Record the path of wheel distribution
+        id: wheel-distribution
+        run: echo "path=$(ls dist/*.whl)" >> $GITHUB_OUTPUT
+      - name: Store the distribution files for use in other stages
+        # `tests` and `publish` will use the same pre-built distributions,
+        # so we make sure to release the exact same package that was tested
+        uses: actions/upload-artifact@v3
+        with:
+          name: python-distribution-files
+          path: dist/
+          retention-days: 1
+
+  test:
+    needs: prepare
+    strategy:
+      matrix:
+        python:
+          # - "3.8" # oldest Python supported by PSF
+          - "3.10" # Required by rhysd/action-setup-vim@v1 on ubuntu-latest
+          # - "3.11" # newest Python that is stable
+        platform:
+          - ubuntu-latest
+        # - macos-latest
+        # - windows-latest
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: nikeee/setup-pandoc@v1
+        with:
+          pandoc-version: '3.1.3' # Compatible with tests for reference_citation.py
+      - uses: actions/setup-python@v5
+        id: setup-python
+        with:
+          python-version: ${{ matrix.python }}
+      - uses: rhysd/action-setup-vim@v1
+      - name: Retrieve pre-built distribution files
+        uses: actions/download-artifact@v3
+        with: { name: python-distribution-files, path: dist/ }
+      - name: Run tests
+        run: >-
+          pipx run --python '${{ steps.setup-python.outputs.python-path }}'
+          tox --installpkg '${{ needs.prepare.outputs.wheel-distribution }}'
+          -- -rFEx --durations 10 --color yes -vv # pytest args
+      - name: Generate coverage report
+        run: pipx run coverage lcov -o coverage.lcov
+      - name: Upload partial coverage report
+        uses: coverallsapp/github-action@master
+        with:
+          path-to-lcov: coverage.lcov
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: ${{ matrix.platform }} - py${{ matrix.python }}
+          parallel: true
+
+  finalize:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Finalize coverage report
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs: finalize
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/panvimwiki
+
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Retrieve pre-built distribution files
+        uses: actions/download-artifact@v3
+        with: { name: python-distribution-files, path: dist/ }
+      - name: Publish distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    needs: [finalize, publish-to-testpypi]
+    if: ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags/') }}
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/panvimwiki # Replace <package-name> with your PyPI project name
+    permissions:
+      # contents: write
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+    steps:
+      # - uses: actions/checkout@v4
+      # - uses: actions/setup-python@v5
+      #   with: {python-version: "3.11"}
+      - name: Retrieve pre-built distribution files
+        uses: actions/download-artifact@v3
+        with: { name: python-distribution-files, path: dist/ }
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+      # - name: Publish Package
+      #   env:
+      #     # TODO: Set your PYPI_TOKEN as a secret using GitHub UI
+      #     # - https://pypi.org/help/#apitoken
+      #     # - https://docs.github.com/en/actions/security-guides/encrypted-secrets
+      #     TWINE_REPOSITORY: pypi
+      #     TWINE_USERNAME: __token__
+      #     TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+      #   run: pipx run tox -e publish
+
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+      - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write # IMPORTANT: mandatory for sigstore
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v3
+        with: { name: python-distribution-files, path: dist/ }
+      - name: Sign the dists with Sigstore
+        uses: sigstore/gh-action-sigstore-python@v2.1.0
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: >-
+          gh release create
+          '${{ github.ref_name }}'
+          --repo '${{ github.repository }}'
+          --notes ""
+      - name: Upload artifact signatures to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        # Upload to GitHub Release using the `gh` CLI.
+        # `dist/` contains the built packages, and the
+        # sigstore-produced signatures and certificates.
+        run: >-
+          gh release upload
+          '${{ github.ref_name }}' dist/**
+          --repo '${{ github.repository }}'

{panvimwiki-0.4.0 → panvimwiki-0.7}/.gitignore

@@ -40,7 +40,8 @@ junit*.xml
 coverage.xml
 .pytest_cache/
 tests/vim/bundle
-prepm.wiki
+Session.vim
+prepm.*
 
 # Build and docs folder/files
 build/*
@@ -55,3 +56,4 @@ MANIFEST
 # Per-project virtualenvs
 .venv*/
 .conda*/
+.python-version

panvimwiki-0.7/.isort.cfg

@@ -0,0 +1,3 @@
+[settings]
+profile = black
+known_first_party = panvimwiki

panvimwiki-0.7/.pre-commit-config.yaml

@@ -0,0 +1,67 @@
+exclude: '^docs/conf.py'
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: trailing-whitespace
+  - id: check-added-large-files
+  - id: check-ast
+  - id: check-json
+  - id: check-merge-conflict
+  - id: check-xml
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+  - id: requirements-txt-fixer
+  - id: mixed-line-ending
+    args: ['--fix=auto']  # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
+
+## If you want to automatically "modernize" your Python code:
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.10.1
+  hooks:
+  - id: pyupgrade
+    args: ['--py37-plus']
+
+## If you want to avoid flake8 errors due to unused vars or imports:
+- repo: https://github.com/PyCQA/autoflake
+  rev: v2.2.0
+  hooks:
+  - id: autoflake
+    args: [
+      --in-place,
+      --remove-all-unused-imports,
+      --remove-unused-variables,
+    ]
+
+- repo: https://github.com/PyCQA/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
+
+- repo: https://github.com/psf/black
+  rev: 23.7.0
+  hooks:
+  - id: black
+    language_version: python3
+
+## If like to embrace black styles even in the docs:
+- repo: https://github.com/asottile/blacken-docs
+  rev: 1.16.0
+  hooks:
+  - id: blacken-docs
+    additional_dependencies: [black]
+
+- repo: https://github.com/PyCQA/flake8
+  rev: 6.1.0
+  hooks:
+  - id: flake8
+  ## You can add flake8 plugins via `additional_dependencies`:
+  #  additional_dependencies: [flake8-bugbear]
+
+## Check for misspells in documentation files:
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.5
+  hooks:
+  - id: codespell

{panvimwiki-0.4.0 → panvimwiki-0.7}/.readthedocs.yml

@@ -16,7 +16,12 @@ sphinx:
 formats:
   - pdf
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
 python:
-  version: 3.8
   install:
     - requirements: docs/requirements.txt
+    - {path: ., method: pip}

panvimwiki-0.7/CHANGELOG.md

@@ -0,0 +1,61 @@
+# Changelog
+
+## Version 0.8 (development)
+
+## Version 0.7 (2024-01-13)
+
+- `:VimwikiReference` no longer converts to reference-links, preferring
+  compatibility with pandoc conversion to `HTML`.
+- DOCS: Update `:help panvimwiki`.
+- DOCS: Host at http://panvimwiki.readthedocs.io/
+
+## Version 0.6 (2024-01-01)
+
+- Vim command `:VimwikiReference` converts
+  [Pandoc Citations](https://pandoc.org/MANUAL.html#citation-syntax)
+  to [reference links](https://pandoc.org/MANUAL.html#reference-links),
+  e.g.,`[anchor:]`, replacing the current file.
+- DOCS: Update `:help`.
+- BUILD: Use pre-commit to remove trailing spaces from Vim help.
+
+## Version 0.5 (2023-12-04)
+
+- Vim command `:VimwikiReference` converts `citeproc` entries and appends to
+  current buffer.
+- Add `reference_citation` to expand `citeproc` entries in markdown with
+  [vim-zettel](https://github.com/michal-h21/vim-zettel)
+- DOCS: add contributing guide.
+- BUILD: Update `panvimdoc` and build Vim help file with tox.
+- BUILD: Upgrade to `pyscaffold` v4.5.
+- BUILD: Add `pre-commit`.
+
+## Version 0.4 (2022-10-30)
+
+- Rename project and package: panvimwiki
+- Add Makefile to build Vim help from Markdown using `panvimdoc`.
+- Pass `$TMP` in tox.ini, so concatenated diary files do not clutter project
+  tree, because when `$TMP` does not exist, use the current working directory.
+- Wiki2pandoc replicates relative path in out—i.e.,
+  `~/vimwiki/diary/2017-04-04.wiki` becomes
+  `~/vimwiki_html/docx/diary/2017-04-04.docx`.
+- Use covimerage to provide coverage for vader tests.
+
+## Version 0.3 (2021-07-07)
+
+- Switch documentation to Markdown.
+- Add panflute and regex filters. Processing can happen solely from the command
+  line.
+- Add Vader.vim tests to bring coverage to 100%.
+- Vim commands `VimwikiConvert` and `VimwikiConvertWeek` default to
+  `~/vimwiki_html/docx/prepm.docx`, rather than `$TMP/prepm.docx`.
+
+## Version 0.2 (2021-05-11)
+
+- Switch build to pyscaffold.
+- Vim :help vimwiki_pandoc
+- Pydoc to view python module help.
+- FIX: prevent taskwiki changes to diary during conversion to docx.
+
+## Version 0.1 (2021-05-01)
+
+- Switch build to flit.