chore: Switch to PDM template

PR #13: #13

Author: pawamoy

.copier-answers.yml

@@ -0,0 +1,20 @@
+# Changes here will be overwritten by Copier
+_commit: 0.9.0
+_src_path: gh:pawamoy/copier-pdm.git
+author_email: pawamoy@pm.me
+author_fullname: Timothée Mazzucotelli
+author_username: pawamoy
+copyright_date: '2019'
+copyright_holder: Timothée Mazzucotelli
+copyright_holder_email: pawamoy@pm.me
+copyright_license: ISC License
+project_description: Automatically link across pages in MkDocs.
+project_name: mkdocs-autorefs
+python_package_command_line_name: mkdocs-autorefs
+python_package_distribution_name: mkdocs-autorefs
+python_package_import_name: mkdocs_autorefs
+repository_name: autorefs
+repository_namespace: mkdocstrings
+repository_provider: github.com
+use_precommit: false
+

.github/FUNDING.yml

@@ -11,11 +11,9 @@ defaults:
     shell: bash
 
 env:
-  LANG: "en_US.utf-8"
-  LC_ALL: "en_US.utf-8"
-  POETRY_VIRTUALENVS_IN_PROJECT: "true"
-  PYTHONIOENCODING: "UTF-8"
-  PYTHONPATH: docs
+  LANG: en_US.utf-8
+  LC_ALL: en_US.utf-8
+  PYTHONIOENCODING: UTF-8
 
 jobs:
 
@@ -27,66 +25,85 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v2
 
-    - name: Set up Python
-      uses: actions/setup-python@v2
+    - name: Set up PDM
+      uses: pdm-project/setup-pdm@v2.5
       with:
-        python-version: 3.8
+        python-version: "3.8"
 
-    - name: Set up the cache
-      uses: actions/cache@v1
+    - name: Set cache variables
+      id: set_variables
+      run: |
+        echo "::set-output name=PIP_CACHE::$(pip cache dir)"
+        echo "::set-output name=PDM_CACHE::$(pdm config cache_dir)"
+
+    - name: Set up cache
+      uses: actions/cache@v2
       with:
-        path: .venv
-        key: quality-venv-cache-2
+        path: |
+          ${{ steps.set_variables.outputs.PIP_CACHE }}
+          ${{ steps.set_variables.outputs.PDM_CACHE }}
+        key: checks-cache
 
-    - name: Set up the project
-      run: |
-        pip install poetry
-        poetry install -v || { rm -rf .venv; poetry install -v; }
-        poetry update
+    - name: Resolving dependencies
+      run: pdm lock
+
+    - name: Install dependencies
+      run: pdm install -G duty -G docs -G quality -G typing -G security
 
     - name: Check if the documentation builds correctly
-      run: poetry run duty check-docs
+      run: pdm run duty check-docs
 
     - name: Check the code quality
-      run: poetry run duty check-code-quality
+      run: pdm run duty check-quality
 
     - name: Check if the code is correctly typed
-      run: poetry run duty check-types
+      run: pdm run duty check-types
 
     - name: Check for vulnerabilities in dependencies
-      run: |
-        pip install safety
-        poetry run duty check-dependencies
+      run: pdm run duty check-dependencies
 
   tests:
 
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        os:
+        - ubuntu-latest
+        - macos-latest
+        - windows-latest
+        python-version:
+        - "3.7"
+        - "3.8"
+        - "3.9"
+        - "3.10"
+        - "3.11-dev"
 
     runs-on: ${{ matrix.os }}
 
     steps:
     - name: Checkout
       uses: actions/checkout@v2
 
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+    - name: Set up PDM
+      uses: pdm-project/setup-pdm@v2.5
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Set up the cache
-      uses: actions/cache@v1
+    - name: Set cache variables
+      id: set_variables
+      run: |
+        echo "::set-output name=PIP_CACHE::$(pip cache dir)"
+        echo "::set-output name=PDM_CACHE::$(pdm config cache_dir)"
+
+    - name: Set up cache
+      uses: actions/cache@v2
       with:
-        path: .venv
-        key: tests-venv-cache-${{ matrix.os }}-py${{ matrix.python-version }}
+        path: |
+          ${{ steps.set_variables.outputs.PIP_CACHE }}
+          ${{ steps.set_variables.outputs.PDM_CACHE }}
+        key: tests-cache-${{ runner.os }}-${{ matrix.python-version }}
 
-    - name: Set up the project
-      run: |
-        pip install poetry
-        poetry install -v || { rm -rf .venv; poetry install -v; }
-        poetry update
+    - name: Install dependencies
+      run: pdm install -G duty -G tests
 
     - name: Run the test suite
-      run: poetry run duty test
+      run: pdm run duty test

.github/workflows/ci.yml

@@ -4,11 +4,13 @@ __pycache__/
 dist/
 *.egg-info/
 build/
+htmlcov/
 .coverage*
 pip-wheel-metadata/
 .pytest_cache/
 .python-version
 site/
-poetry.lock
-.mypy_cache/
+pdm.lock
+.pdm.toml
+__pypackages__/
 .venv/

.gitignore

@@ -0,0 +1,7 @@
+FROM gitpod/workspace-full
+USER gitpod
+ENV PIP_USER=no
+ENV PYTHON_VERSIONS=
+RUN pip3 install pipx; \
+    pipx install pdm; \
+    pipx ensurepath

.gitpod.dockerfile

@@ -0,0 +1,13 @@
+vscode:
+  extensions:
+  - ms-python.python
+
+image:
+  file: .gitpod.dockerfile
+
+ports:
+- port: 8000
+  onOpen: notify
+
+tasks:
+- init: make setup

.gitpod.yml

@@ -36,7 +36,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Features
 - Allow registering absolute URLs for autorefs ([621686b](https://github.com/mkdocstrings/autorefs/commit/621686b4b36b8d24df80035095700f6a4f96567c) by Oleh Prypin). [PR #8](https://github.com/mkdocstrings/autorefs/pull/8)
 - Allow external tools to insert references that are OK to skip ([7619c28](https://github.com/mkdocstrings/autorefs/commit/7619c2835a63b54b1f5e9e11c5f320c04e3579ac) by Oleh Prypin). [PR #7](https://github.com/mkdocstrings/autorefs/pull/7)
-- Allow [`identifier`][], understood as [`identifier`][identifier] ([2d3182d](https://github.com/mkdocstrings/autorefs/commit/2d3182db54dc33e75914e9c509bbf849842eb70a) by Oleh Prypin). [PR #5](https://github.com/mkdocstrings/autorefs/pull/5)
+- Allow `[``identifier``][]`, understood as `[``identifier``][identifier]` ([2d3182d](https://github.com/mkdocstrings/autorefs/commit/2d3182db54dc33e75914e9c509bbf849842eb70a) by Oleh Prypin). [PR #5](https://github.com/mkdocstrings/autorefs/pull/5)
 
 
 ## [0.1.1](https://github.com/mkdocstrings/autorefs/releases/tag/0.1.1) - 2021-02-28

CHANGELOG.md

@@ -17,21 +17,23 @@ make setup
 !!! note
     If it fails for some reason,
     you'll need to install
-    [Poetry](https://github.com/python-poetry/poetry)
+    [PDM](https://github.com/pdm-project/pdm)
     manually.
 
     You can install it with:
 
     ```bash
     python3 -m pip install --user pipx
-    pipx install poetry
+    pipx install pdm
     ```
 
     Now you can try running `make setup` again,
-    or simply `poetry install`.
+    or simply `pdm install`.
 
 You now have the dependencies installed.
 
+You can run the application with `pdm run mkdocs-autorefs [ARGS...]`.
+
 Run `make help` to see all the available actions!
 
 ## Tasks
@@ -43,11 +45,9 @@ on multiple Python versions, you can do one of the following:
 
 1. `export PYTHON_VERSIONS= `: this will run the task
    with only the current Python version
-2. run the task directly with `poetry run duty TASK`,
-   or `duty TASK` if the environment was already activated
-   through `poetry shell`
+2. run the task directly with `pdm run duty TASK`
 
-The Makefile detects if the Poetry environment is activated,
+The Makefile detects if a virtual environment is activated,
 so `make` will work the same with the virtualenv activated or not.
 
 ## Development

CONTRIBUTING.md

@@ -1,16 +1,17 @@
 .DEFAULT_GOAL := help
 SHELL := bash
 
-DUTY = $(shell [ -n "${VIRTUAL_ENV}" ] || echo poetry run) duty
+DUTY = $(shell [ -n "${VIRTUAL_ENV}" ] || echo pdm run) duty
 
 args = $(foreach a,$($(subst -,_,$1)_args),$(if $(value $a),$a="$($a)"))
-check_code_quality_args = files
+check_quality_args = files
 docs_serve_args = host port
 release_args = version
 test_args = cleancov match
 
 BASIC_DUTIES = \
 	changelog \
+	check-dependencies \
 	clean \
 	coverage \
 	docs \
@@ -21,9 +22,7 @@ BASIC_DUTIES = \
 	release
 
 QUALITY_DUTIES = \
-	check \
-	check-code-quality \
-	check-dependencies \
+	check-quality \
 	check-docs \
 	check-types \
 	test
@@ -32,10 +31,19 @@ QUALITY_DUTIES = \
 help:
 	@$(DUTY) --list
 
+.PHONY: lock
+lock:
+	@pdm lock
+
 .PHONY: setup
 setup:
 	@bash scripts/setup.sh
 
+.PHONY: check
+check:
+	@bash scripts/multirun.sh duty check-quality check-types check-docs
+	@$(DUTY) check-dependencies
+
 .PHONY: $(BASIC_DUTIES)
 $(BASIC_DUTIES):
 	@$(DUTY) $@ $(call args,$@)

Makefile

@@ -1,8 +1,10 @@
 # mkdocs-autorefs
 
 [![ci](https://github.com/mkdocstrings/autorefs/workflows/ci/badge.svg)](https://github.com/mkdocstrings/autorefs/actions?query=workflow%3Aci)
-[![pypi version](https://img.shields.io/pypi/v/mkdocs-autorefs.svg)](https://pypi.org/project/mkdocs-autorefs/)
-[![gitter](https://badges.gitter.im/join%20chat.svg)](https://gitter.im/mkdocstrings/community)
+[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://mkdocstrings.github.io/autorefs/)
+[![pypi version](https://img.shields.io/pypi/v/autorefs.svg)](https://pypi.org/project/autorefs/)
+[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/autorefs)
+[![gitter](https://badges.gitter.im/join%20chat.svg)](https://gitter.im/autorefs/community)
 
 Automatically link across pages in MkDocs.
 
@@ -49,10 +51,10 @@ Note that this plugin's behavior is undefined when trying to link to a heading t
 
 ## Requirements
 
-`mkdocs-autorefs` requires Python 3.6 or above.
+mkdocs-autorefs requires Python 3.7 or above.
 
 <details>
-<summary>To install Python 3.6, I recommend using <a href="https://github.com/pyenv/pyenv"><code>pyenv</code></a>.</summary>
+<summary>To install Python 3.7, I recommend using <a href="https://github.com/pyenv/pyenv"><code>pyenv</code></a>.</summary>
 
 ```bash
 # install pyenv
@@ -63,10 +65,10 @@ export PATH="${HOME}/.pyenv/bin:${PATH}"
 export PYENV_ROOT="${HOME}/.pyenv"
 eval "$(pyenv init -)"
 
-# install Python 3.6
-pyenv install 3.6.12
+# install Python 3.7
+pyenv install 3.7.12
 
 # make it available globally
-pyenv global system 3.6.12
+pyenv global system 3.7.12
 ```
 </details>