chore: Switch to PDM

Author: pawamoy

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: e9e472d
+_commit: 0.2.2
 _src_path: gh:pawamoy/copier-pdm
 author_email: pawamoy@pm.me
 author_fullname: "Timoth\xE9e Mazzucotelli"

.github/workflows/ci.yml

@@ -17,14 +17,6 @@ env:
   LC_ALL: en_US.utf-8
   PYTHONIOENCODING: UTF-8
 
-  # To fix an error when running Poetry on Windows
-  # (https://github.com/python-poetry/poetry/issues/2629),
-  # we set Poetry's cache directory to .poetry_cache in the current directory.
-  # It makes it easier to later remove the virtualenv when it's broken.
-  # Absolute path is necessary to avoid this issue:
-  # https://github.com/python-poetry/poetry/issues/3049
-  POETRY_CACHE_DIR: ${{ github.workspace }}/.poetry_cache
-
 jobs:
 
   quality:
@@ -35,36 +27,44 @@ 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@v1.1
       with:
         python-version: 3.8
 
-    - name: Set up Poetry
-      run: pip install poetry
+    - 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 the cache
-      uses: actions/cache@v1
+    - name: Set up cache
+      uses: actions/cache@v2
       with:
-        path: .poetry_cache
-        key: quality-poetry-cache
+        path: |
+          ${{ steps.set_variables.outputs.PIP_CACHE }}
+          ${{ steps.set_variables.outputs.PDM_CACHE }}
+        key: checks-cache
+
+    - name: Resolving dependencies
+      run: pdm lock
 
-    - name: Set up the project
-      run: poetry install -vv -E numpy-style
+    - name: Install dependencies
+      run: |
+        pdm install -s duty -s docs -s quality -s typing
+        pip install safety
 
     - 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-code-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:
 
@@ -77,24 +77,31 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      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@v1.1
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Set up Poetry
-      run: pip install poetry
+    - 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 the cache
-      uses: actions/cache@v1
+    - name: Set up cache
+      uses: actions/cache@v2
       with:
-        path: .poetry_cache
-        key: tests-poetry-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: poetry install -vv -E numpy-style || { rm -rf .poetry_cache/virtualenvs/*; poetry install -vv -E numpy-style; }
+    - name: Install dependencies
+      run: |
+        pdm use -f ${{ matrix.python-version }}
+        pdm install -s duty -s tests
 
     - name: Run the test suite
-      run: poetry run duty test
+      run: pdm run duty test

.gitignore

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

CONTRIBUTING.md

@@ -17,22 +17,22 @@ 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 -E numpy-style`.
+    or simply `pdm install`.
 
 You now have the dependencies installed.
 
-You can run the application with `poetry run pytkdocs [ARGS...]`.
+You can run the application with `pdm run pytkdocs [ARGS...]`.
 
 Run `make help` to see all the available actions!
 
@@ -45,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

Makefile

@@ -1,7 +1,7 @@
 .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

config/coverage.ini

@@ -1,24 +1,21 @@
-[coverage:paths]
-source =
-  src/pytkdocs
-  */site-packages/pytkdocs
-
 [coverage:run]
 branch = true
-source =
-  src/pytkdocs
-  tests
 parallel = true
+source =
+  src/
+  tests/
+
+[coverage:paths]
+equivalent =
+  src/
+  __pypackages__/
 
 [coverage:report]
 precision = 2
 omit =
-  src/pytkdocs/__init__.py
-  src/pytkdocs/__main__.py
-  tests/*
-
-[coverage:html]
-directory = build/coverage
+  src/*/__init__.py
+  src/*/__main__.py
+  tests/__init__.py
 
 [coverage:json]
-output = build/coverage.json
+output = htmlcov/coverage.json

docs/credits.md

@@ -1 +1,17 @@
-{{ credits() }}
+# Credits
+
+These projects were used to build *[[ project_name ]]*. **Thank you!**
+
+[`python`](https://www.python.org/) |
+[`pdm`](https://pdm.fming.dev/) |
+[`copier-pdm`](https://github.com/pawamoy/copier-pdm)
+
+### Direct dependencies
+
+{{ cite_packages(package_info, direct_dependencies) }}
+
+### Indirect dependencies
+
+{{ cite_packages(package_info, indirect_dependencies) }}
+
+**[More credits from the author](http://pawamoy.github.io/credits/)**

docs/macros.py

@@ -1,13 +1,10 @@
 """Macros and filters made available in Markdown pages."""
 
-import functools
+import re
 from itertools import chain
 from pathlib import Path
 
-import httpx
 import toml
-from jinja2 import StrictUndefined
-from jinja2.sandbox import SandboxedEnvironment
 from pip._internal.commands.show import search_packages_info  # noqa: WPS436 (no other way?)
 
 
@@ -19,19 +16,23 @@ def get_credits_data() -> dict:
         Data required to render the credits template.
     """
     project_dir = Path(__file__).parent.parent
-    metadata = toml.load(project_dir / "pyproject.toml")["tool"]["poetry"]
-    lock_data = toml.load(project_dir / "poetry.lock")
+    metadata = toml.load(project_dir / "pyproject.toml")["project"]
+    metadata_pdm = toml.load(project_dir / "pyproject.toml")["tool"]["pdm"]
+    lock_data = toml.load(project_dir / "pdm.lock")
     project_name = metadata["name"]
 
-    poetry_dependencies = chain(metadata["dependencies"].keys(), metadata["dev-dependencies"].keys())
-    direct_dependencies = {dep.lower() for dep in poetry_dependencies}
-    direct_dependencies.remove("python")
+    all_dependencies = chain(
+        metadata.get("dependencies", []),
+        chain(*metadata.get("optional-dependencies", {}).values()),
+        chain(*metadata_pdm.get("dev-dependencies", {}).values()),
+    )
+    direct_dependencies = {re.sub(r"[^\w-].*$", "", dep) for dep in all_dependencies}
+    direct_dependencies = {dep.lower() for dep in direct_dependencies}
     indirect_dependencies = {pkg["name"].lower() for pkg in lock_data["package"]}
     indirect_dependencies -= direct_dependencies
-    dependencies = direct_dependencies | indirect_dependencies
 
     packages = {}
-    for pkg in search_packages_info(dependencies):
+    for pkg in search_packages_info(direct_dependencies | indirect_dependencies):  # type: ignore
         pkg = {_: pkg[_] for _ in ("name", "home-page")}
         packages[pkg["name"].lower()] = pkg
 
@@ -49,22 +50,6 @@ def get_credits_data() -> dict:
     }
 
 
-@functools.lru_cache(maxsize=None)
-def get_credits():
-    """
-    Return credits as Markdown.
-
-    Returns:
-        The credits page Markdown.
-    """
-    jinja_env = SandboxedEnvironment(undefined=StrictUndefined)
-    commit = "166758a98d5e544aaa94fda698128e00733497f4"
-    template_url = f"https://raw.githubusercontent.com/pawamoy/jinja-templates/{commit}/credits.md"
-    template_data = get_credits_data()
-    template_text = httpx.get(template_url).text
-    return jinja_env.from_string(template_text).render(**template_data)
-
-
 def define_env(env):
     """
     Add macros and filters into the Jinja2 environment.
@@ -75,7 +60,13 @@ def define_env(env):
     Arguments:
         env: An object used to add macros and filters to the environment.
     """
+    env.variables.update(get_credits_data())
+
+    @env.macro  # noqa: WPS430
+    def cite_package(info, name):  # noqa: WPS430
+        package = info.get(name, {})
+        return f"[`{package.get('name', name)}`]({package.get('home-page', '')})"
 
-    @env.macro  # noqa: WPS430 (nested function)
-    def credits():  # noqa: WPS430
-        return get_credits()
+    @env.macro  # noqa: WPS430
+    def cite_packages(info, names):  # noqa: WPS430
+        return " | ".join(cite_package(info, name) for name in names)