├── .copier-answers.yml
├── .envrc
├── .github
├── FUNDING.yml
├── ISSUE_TEMPLATE
│ ├── 1-bug.md
│ ├── 2-feature.md
│ ├── 3-docs.md
│ ├── 4-change.md
│ └── config.yml
└── workflows
│ ├── ci.yml
│ └── release.yml
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
├── config
├── coverage.ini
├── git-changelog.toml
├── mypy.ini
├── pytest.ini
├── ruff.toml
└── vscode
│ ├── launch.json
│ ├── settings.json
│ └── tasks.json
├── docs
├── .overrides
│ ├── main.html
│ └── partials
│ │ ├── comments.html
│ │ └── path-item.html
├── changelog.md
├── code_of_conduct.md
├── contributing.md
├── credits.md
├── css
│ ├── material.css
│ └── mkdocstrings.css
├── gen_credits.py
├── index.md
├── js
│ └── feedback.js
├── license.md
└── reference
│ └── copier_templates_extensions.md
├── duties.py
├── mkdocs.yml
├── pyproject.toml
├── scripts
├── gen_api_ref.py
├── gen_credits.py
├── get_version.py
├── make
└── make.py
├── src
└── copier_templates_extensions
│ ├── __init__.py
│ ├── _internal
│ ├── __init__.py
│ ├── context.py
│ ├── debug.py
│ └── loader.py
│ └── py.typed
└── tests
├── __init__.py
├── fixtures
├── answer_access
│ ├── copier.yml
│ ├── extensions.py
│ └── result.txt.jinja
├── cant_find_extension_class
│ ├── copier.yml
│ └── extensions.py
├── cant_find_extension_file
│ └── copier.yml
├── cant_find_extension_module
│ └── copier.yml
├── cant_find_extension_package
│ └── copier.yml
├── dataclass
│ ├── copier.yml
│ ├── extensions
│ │ └── ctx.py
│ └── template
│ │ └── result.txt.jinja
├── deprecation_warning_hook_return
│ ├── copier.yml
│ ├── extensions.py
│ └── result.txt.jinja
├── deprecation_warning_update_attr
│ ├── copier.yml
│ ├── extensions.py
│ └── result.txt.jinja
├── loading_normal_extension
│ ├── copier.yml
│ └── result.txt.jinja
├── modifying_context
│ ├── copier.yml
│ ├── extensions.py
│ └── result.txt.jinja
├── not_updating_context_for_prompts
│ ├── copier.yml
│ ├── extensions.py
│ └── result.txt.jinja
├── not_using_loader
│ └── result.txt.jinja
├── raising_exception_while_loading
│ ├── copier.yml
│ └── extensions.py
├── updating_context
│ ├── copier.yml
│ ├── extensions.py
│ └── result.txt.jinja
└── using_loader
│ ├── copier.yml
│ ├── extensions.py
│ └── result.txt.jinja
├── test_api.py
└── test_extensions.py
/.copier-answers.yml:
--------------------------------------------------------------------------------
1 | # Changes here will be overwritten by Copier.
2 | _commit: 1.7.1
3 | _src_path: gh:pawamoy/copier-uv
4 | author_email: dev@pawamoy.fr
5 | author_fullname: Timothée Mazzucotelli
6 | author_username: pawamoy
7 | copyright_date: '2021'
8 | copyright_holder: Timothée Mazzucotelli
9 | copyright_holder_email: dev@pawamoy.fr
10 | copyright_license: ISC
11 | insiders: false
12 | project_description: Special Jinja2 extension for Copier that allows to load extensions
13 | using file paths relative to the template root instead of Python dotted paths.
14 | project_name: Copier Templates Extensions
15 | python_package_command_line_name: ''
16 | python_package_distribution_name: copier-templates-extensions
17 | python_package_import_name: copier_templates_extensions
18 | repository_name: copier-templates-extensions
19 | repository_namespace: copier-org
20 | repository_provider: github.com
21 |
22 |
--------------------------------------------------------------------------------
/.envrc:
--------------------------------------------------------------------------------
1 | PATH_add scripts
2 |
--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | github: pawamoy
2 | polar: pawamoy
3 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/1-bug.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Bug report
3 | about: Create a bug report to help us improve.
4 | title: "bug: "
5 | labels: unconfirmed
6 | assignees: [pawamoy]
7 | ---
8 |
9 | ### Description of the bug
10 |
11 |
12 | ### To Reproduce
13 |
28 |
29 | ```
30 | WRITE MRE / INSTRUCTIONS HERE
31 | ```
32 |
33 | ### Full traceback
34 |
36 |
37 | Full traceback
38 |
39 | ```python
40 | PASTE TRACEBACK HERE
41 | ```
42 |
43 |
4 |
5 |
21 |
22 |
23 |
57 |
--------------------------------------------------------------------------------
/docs/.overrides/partials/path-item.html:
--------------------------------------------------------------------------------
1 | {# Fix breadcrumbs for when mkdocs-section-index is used. #}
2 | {# See https://github.com/squidfunk/mkdocs-material/issues/7614. #}
3 |
4 |
5 | {% macro render_content(nav_item) %}
6 |
7 | {{ nav_item.title }}
8 |
9 | {% endmacro %}
10 |
11 |
12 | {% macro render(nav_item, ref=nav_item) %}
13 | {% if nav_item.is_page %}
14 |
15 |
16 | {{ render_content(ref) }}
17 |
18 |
19 | {% elif nav_item.children %}
20 | {{ render(nav_item.children | first, ref) }}
21 | {% endif %}
22 | {% endmacro %}
23 |
--------------------------------------------------------------------------------
/docs/changelog.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Changelog
3 | ---
4 |
5 | --8<-- "CHANGELOG.md"
6 |
--------------------------------------------------------------------------------
/docs/code_of_conduct.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Code of Conduct
3 | ---
4 |
5 | --8<-- "CODE_OF_CONDUCT.md"
6 |
--------------------------------------------------------------------------------
/docs/contributing.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Contributing
3 | ---
4 |
5 | --8<-- "CONTRIBUTING.md"
6 |
--------------------------------------------------------------------------------
/docs/credits.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Credits
3 | hide:
4 | - toc
5 | ---
6 |
7 | ```python exec="yes"
8 | --8<-- "scripts/gen_credits.py"
9 | ```
10 |
--------------------------------------------------------------------------------
/docs/css/material.css:
--------------------------------------------------------------------------------
1 | /* More space at the bottom of the page. */
2 | .md-main__inner {
3 | margin-bottom: 1.5rem;
4 | }
5 |
--------------------------------------------------------------------------------
/docs/css/mkdocstrings.css:
--------------------------------------------------------------------------------
1 | /* Indentation. */
2 | div.doc-contents:not(.first) {
3 | padding-left: 25px;
4 | border-left: .05rem solid var(--md-typeset-table-color);
5 | }
6 |
7 | /* Mark external links as such. */
8 | a.external::after,
9 | a.autorefs-external::after {
10 | /* https://primer.style/octicons/arrow-up-right-24 */
11 | mask-image: url('data:image/svg+xml,');
12 | -webkit-mask-image: url('data:image/svg+xml,');
13 | content: ' ';
14 |
15 | display: inline-block;
16 | vertical-align: middle;
17 | position: relative;
18 |
19 | height: 1em;
20 | width: 1em;
21 | background-color: currentColor;
22 | }
23 |
24 | a.external:hover::after,
25 | a.autorefs-external:hover::after {
26 | background-color: var(--md-accent-fg-color);
27 | }
--------------------------------------------------------------------------------
/docs/gen_credits.py:
--------------------------------------------------------------------------------
1 | """Generate the credits page."""
2 |
3 | import functools
4 | import re
5 | from itertools import chain
6 | from pathlib import Path
7 | from urllib.request import urlopen
8 |
9 | import mkdocs_gen_files
10 | import toml
11 | from jinja2 import StrictUndefined
12 | from jinja2.sandbox import SandboxedEnvironment
13 |
14 |
15 | def get_credits_data() -> dict:
16 | """Return data used to generate the credits file.
17 |
18 | Returns:
19 | Data required to render the credits template.
20 | """
21 | project_dir = Path(__file__).parent.parent
22 | metadata = toml.load(project_dir / "pyproject.toml")["project"]
23 | metadata_pdm = toml.load(project_dir / "pyproject.toml")["tool"]["pdm"]
24 | lock_data = toml.load(project_dir / "pdm.lock")
25 | project_name = metadata["name"]
26 |
27 | all_dependencies = chain(
28 | metadata.get("dependencies", []),
29 | chain(*metadata.get("optional-dependencies", {}).values()),
30 | chain(*metadata_pdm.get("dev-dependencies", {}).values()),
31 | )
32 | direct_dependencies = {re.sub(r"[^\w-].*$", "", dep) for dep in all_dependencies}
33 | direct_dependencies = {dep.lower() for dep in direct_dependencies}
34 | indirect_dependencies = {pkg["name"].lower() for pkg in lock_data["package"]}
35 | indirect_dependencies -= direct_dependencies
36 |
37 | return {
38 | "project_name": project_name,
39 | "direct_dependencies": sorted(direct_dependencies),
40 | "indirect_dependencies": sorted(indirect_dependencies),
41 | "more_credits": "http://pawamoy.github.io/credits/",
42 | }
43 |
44 |
45 | @functools.lru_cache(maxsize=None)
46 | def get_credits():
47 | """Return credits as Markdown.
48 |
49 | Returns:
50 | The credits page Markdown.
51 | """
52 | jinja_env = SandboxedEnvironment(undefined=StrictUndefined)
53 | commit = "c78c29caa345b6ace19494a98b1544253cbaf8c1"
54 | template_url = f"https://raw.githubusercontent.com/pawamoy/jinja-templates/{commit}/credits.md"
55 | template_data = get_credits_data()
56 | template_text = urlopen(template_url).read().decode("utf8") # noqa: S310
57 | return jinja_env.from_string(template_text).render(**template_data)
58 |
59 |
60 | with mkdocs_gen_files.open("credits.md", "w") as fd:
61 | fd.write(get_credits())
62 | mkdocs_gen_files.set_edit_path("credits.md", "gen_credits.py")
63 |
--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Overview
3 | hide:
4 | - feedback
5 | ---
6 |
7 | --8<-- "README.md"
8 |
--------------------------------------------------------------------------------
/docs/js/feedback.js:
--------------------------------------------------------------------------------
1 | const feedback = document.forms.feedback;
2 | feedback.hidden = false;
3 |
4 | feedback.addEventListener("submit", function(ev) {
5 | ev.preventDefault();
6 | const commentElement = document.getElementById("feedback");
7 | commentElement.style.display = "block";
8 | feedback.firstElementChild.disabled = true;
9 | const data = ev.submitter.getAttribute("data-md-value");
10 | const note = feedback.querySelector(".md-feedback__note [data-md-value='" + data + "']");
11 | if (note) {
12 | note.hidden = false;
13 | }
14 | })
15 |
--------------------------------------------------------------------------------
/docs/license.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: License
3 | hide:
4 | - feedback
5 | ---
6 |
7 | # License
8 |
9 | ```
10 | --8<-- "LICENSE"
11 | ```
12 |
--------------------------------------------------------------------------------
/docs/reference/copier_templates_extensions.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: API reference
3 | hide:
4 | - navigation
5 | ---
6 |
7 | # ::: copier_templates_extensions
8 |
--------------------------------------------------------------------------------
/duties.py:
--------------------------------------------------------------------------------
1 | """Development tasks."""
2 |
3 | from __future__ import annotations
4 |
5 | import os
6 | import re
7 | import sys
8 | from contextlib import contextmanager
9 | from importlib.metadata import version as pkgversion
10 | from pathlib import Path
11 | from typing import TYPE_CHECKING
12 |
13 | from duty import duty, tools
14 |
15 | if TYPE_CHECKING:
16 | from collections.abc import Iterator
17 |
18 | from duty.context import Context
19 |
20 |
21 | PY_SRC_PATHS = (Path(_) for _ in ("src", "tests", "duties.py", "scripts"))
22 | PY_SRC_LIST = tuple(str(_) for _ in PY_SRC_PATHS)
23 | PY_SRC = " ".join(PY_SRC_LIST)
24 | CI = os.environ.get("CI", "0") in {"1", "true", "yes", ""}
25 | WINDOWS = os.name == "nt"
26 | PTY = not WINDOWS and not CI
27 | MULTIRUN = os.environ.get("MULTIRUN", "0") == "1"
28 |
29 |
30 | def pyprefix(title: str) -> str:
31 | if MULTIRUN:
32 | prefix = f"(python{sys.version_info.major}.{sys.version_info.minor})"
33 | return f"{prefix:14}{title}"
34 | return title
35 |
36 |
37 | @contextmanager
38 | def material_insiders() -> Iterator[bool]:
39 | if "+insiders" in pkgversion("mkdocs-material"):
40 | os.environ["MATERIAL_INSIDERS"] = "true"
41 | try:
42 | yield True
43 | finally:
44 | os.environ.pop("MATERIAL_INSIDERS")
45 | else:
46 | yield False
47 |
48 |
49 | def _get_changelog_version() -> str:
50 | changelog_version_re = re.compile(r"^## \[(\d+\.\d+\.\d+)\].*$")
51 | with Path(__file__).parent.joinpath("CHANGELOG.md").open("r", encoding="utf8") as file:
52 | return next(filter(bool, map(changelog_version_re.match, file))).group(1) # type: ignore[union-attr]
53 |
54 |
55 | @duty
56 | def changelog(ctx: Context, bump: str = "") -> None:
57 | """Update the changelog in-place with latest commits.
58 |
59 | Parameters:
60 | bump: Bump option passed to git-changelog.
61 | """
62 | ctx.run(tools.git_changelog(bump=bump or None), title="Updating changelog")
63 | ctx.run(tools.yore.check(bump=bump or _get_changelog_version()), title="Checking legacy code")
64 |
65 |
66 | @duty(pre=["check-quality", "check-types", "check-docs", "check-api"])
67 | def check(ctx: Context) -> None:
68 | """Check it all!"""
69 |
70 |
71 | @duty
72 | def check_quality(ctx: Context) -> None:
73 | """Check the code quality."""
74 | ctx.run(
75 | tools.ruff.check(*PY_SRC_LIST, config="config/ruff.toml"),
76 | title=pyprefix("Checking code quality"),
77 | )
78 |
79 |
80 | @duty
81 | def check_docs(ctx: Context) -> None:
82 | """Check if the documentation builds correctly."""
83 | Path("htmlcov").mkdir(parents=True, exist_ok=True)
84 | Path("htmlcov/index.html").touch(exist_ok=True)
85 | with material_insiders():
86 | ctx.run(
87 | tools.mkdocs.build(strict=True, verbose=True),
88 | title=pyprefix("Building documentation"),
89 | )
90 |
91 |
92 | @duty
93 | def check_types(ctx: Context) -> None:
94 | """Check that the code is correctly typed."""
95 | os.environ["FORCE_COLOR"] = "1"
96 | ctx.run(
97 | tools.mypy(*PY_SRC_LIST, config_file="config/mypy.ini"),
98 | title=pyprefix("Type-checking"),
99 | )
100 |
101 |
102 | @duty
103 | def check_api(ctx: Context, *cli_args: str) -> None:
104 | """Check for API breaking changes."""
105 | ctx.run(
106 | tools.griffe.check("copier_templates_extensions", search=["src"], color=True).add_args(*cli_args),
107 | title="Checking for API breaking changes",
108 | nofail=True,
109 | )
110 |
111 |
112 | @duty
113 | def docs(ctx: Context, *cli_args: str, host: str = "127.0.0.1", port: int = 8000) -> None:
114 | """Serve the documentation (localhost:8000).
115 |
116 | Parameters:
117 | host: The host to serve the docs from.
118 | port: The port to serve the docs on.
119 | """
120 | with material_insiders():
121 | ctx.run(
122 | tools.mkdocs.serve(dev_addr=f"{host}:{port}").add_args(*cli_args),
123 | title="Serving documentation",
124 | capture=False,
125 | )
126 |
127 |
128 | @duty
129 | def docs_deploy(ctx: Context) -> None:
130 | """Deploy the documentation on GitHub pages.
131 |
132 | Parameters:
133 | ctx: The context instance (passed automatically).
134 | """
135 | # os.environ["DEPLOY"] = "true"
136 | # with material_insiders() as insiders:
137 | # if not insiders:
138 | # ctx.run(lambda: False, title="Not deploying docs without Material for MkDocs Insiders!")
139 | # ctx.run(mkdocs.gh_deploy(), title="Deploying documentation")
140 | ctx.run("false", title="We do not deploy docs for this project yet.", nofail=True)
141 |
142 |
143 | @duty
144 | def format(ctx: Context) -> None:
145 | """Run formatting tools on the code."""
146 | ctx.run(
147 | tools.ruff.check(*PY_SRC_LIST, config="config/ruff.toml", fix_only=True, exit_zero=True),
148 | title="Auto-fixing code",
149 | )
150 | ctx.run(tools.ruff.format(*PY_SRC_LIST, config="config/ruff.toml"), title="Formatting code")
151 |
152 |
153 | @duty
154 | def build(ctx: Context) -> None:
155 | """Build source and wheel distributions."""
156 | ctx.run(
157 | tools.build(),
158 | title="Building source and wheel distributions",
159 | pty=PTY,
160 | )
161 |
162 |
163 | @duty
164 | def publish(ctx: Context) -> None:
165 | """Publish source and wheel distributions to PyPI."""
166 | if not Path("dist").exists():
167 | ctx.run("false", title="No distribution files found")
168 | dists = [str(dist) for dist in Path("dist").iterdir()]
169 | ctx.run(
170 | tools.twine.upload(*dists, skip_existing=True),
171 | title="Publishing source and wheel distributions to PyPI",
172 | pty=PTY,
173 | )
174 |
175 |
176 | @duty(post=["build", "publish", "docs-deploy"])
177 | def release(ctx: Context, version: str = "") -> None:
178 | """Release a new Python package.
179 |
180 | Parameters:
181 | version: The new version number to use.
182 | """
183 | if not (version := (version or input("> Version to release: ")).strip()):
184 | ctx.run("false", title="A version must be provided")
185 | ctx.run("git add pyproject.toml CHANGELOG.md", title="Staging files", pty=PTY)
186 | ctx.run(["git", "commit", "-m", f"chore: Prepare release {version}"], title="Committing changes", pty=PTY)
187 | ctx.run(f"git tag {version}", title="Tagging commit", pty=PTY)
188 | ctx.run("git push", title="Pushing commits", pty=False)
189 | ctx.run("git push --tags", title="Pushing tags", pty=False)
190 |
191 |
192 | @duty(silent=True, aliases=["cov"])
193 | def coverage(ctx: Context) -> None:
194 | """Report coverage as text and HTML."""
195 | ctx.run(tools.coverage.combine(), nofail=True)
196 | ctx.run(tools.coverage.report(rcfile="config/coverage.ini"), capture=False)
197 | ctx.run(tools.coverage.html(rcfile="config/coverage.ini"))
198 |
199 |
200 | @duty
201 | def test(ctx: Context, *cli_args: str, match: str = "") -> None:
202 | """Run the test suite.
203 |
204 | Parameters:
205 | match: A pytest expression to filter selected tests.
206 | """
207 | py_version = f"{sys.version_info.major}{sys.version_info.minor}"
208 | os.environ["COVERAGE_FILE"] = f".coverage.{py_version}"
209 | ctx.run(
210 | tools.pytest(
211 | "tests",
212 | config_file="config/pytest.ini",
213 | select=match,
214 | color="yes",
215 | ).add_args("-n", "auto", *cli_args),
216 | title=pyprefix("Running tests"),
217 | )
218 |
--------------------------------------------------------------------------------
/mkdocs.yml:
--------------------------------------------------------------------------------
1 | site_name: "Copier Templates Extensions"
2 | site_description: "Special Jinja2 extension for Copier that allows to load extensions using file paths relative to the template root instead of Python dotted paths."
3 | site_url: "https://copier-org.github.io/copier-templates-extensions"
4 | repo_url: "https://github.com/copier-org/copier-templates-extensions"
5 | repo_name: "copier-org/copier-templates-extensions"
6 | site_dir: "site"
7 | watch: [mkdocs.yml, README.md, CONTRIBUTING.md, CHANGELOG.md, src/copier_templates_extensions]
8 | copyright: Copyright © 2021 Timothée Mazzucotelli
9 | edit_uri: edit/main/docs/
10 |
11 | validation:
12 | omitted_files: warn
13 | absolute_links: warn
14 | unrecognized_links: warn
15 |
16 | nav:
17 | - Home:
18 | - Overview: index.md
19 | - Changelog: changelog.md
20 | - Credits: credits.md
21 | - License: license.md
22 | - API reference: reference/copier_templates_extensions.md
23 | - Development:
24 | - Contributing: contributing.md
25 | - Code of Conduct: code_of_conduct.md
26 | - Coverage report: coverage.md
27 | - Author's website: https://pawamoy.github.io/
28 |
29 | theme:
30 | name: material
31 | custom_dir: docs/.overrides
32 | icon:
33 | logo: material/currency-sign
34 | features:
35 | - announce.dismiss
36 | - content.action.edit
37 | - content.action.view
38 | - content.code.annotate
39 | - content.code.copy
40 | - content.tooltips
41 | - navigation.footer
42 | - navigation.instant.preview
43 | - navigation.path
44 | - navigation.sections
45 | - navigation.tabs
46 | - navigation.tabs.sticky
47 | - navigation.top
48 | - search.highlight
49 | - search.suggest
50 | - toc.follow
51 | palette:
52 | - media: "(prefers-color-scheme)"
53 | toggle:
54 | icon: material/brightness-auto
55 | name: Switch to light mode
56 | - media: "(prefers-color-scheme: light)"
57 | scheme: default
58 | primary: teal
59 | accent: purple
60 | toggle:
61 | icon: material/weather-sunny
62 | name: Switch to dark mode
63 | - media: "(prefers-color-scheme: dark)"
64 | scheme: slate
65 | primary: black
66 | accent: lime
67 | toggle:
68 | icon: material/weather-night
69 | name: Switch to system preference
70 |
71 | extra_css:
72 | - css/material.css
73 | - css/mkdocstrings.css
74 |
75 | extra_javascript:
76 | - js/feedback.js
77 |
78 | markdown_extensions:
79 | - attr_list
80 | - admonition
81 | - callouts
82 | - footnotes
83 | - pymdownx.emoji:
84 | emoji_index: !!python/name:material.extensions.emoji.twemoji
85 | emoji_generator: !!python/name:material.extensions.emoji.to_svg
86 | - pymdownx.magiclink
87 | - pymdownx.snippets:
88 | base_path: [!relative $config_dir]
89 | check_paths: true
90 | - pymdownx.superfences
91 | - pymdownx.tabbed:
92 | alternate_style: true
93 | slugify: !!python/object/apply:pymdownx.slugs.slugify
94 | kwds:
95 | case: lower
96 | - pymdownx.tasklist:
97 | custom_checkbox: true
98 | - toc:
99 | permalink: "¤"
100 |
101 | plugins:
102 | - search
103 | - markdown-exec
104 | - section-index
105 | - coverage
106 | - mkdocstrings:
107 | handlers:
108 | python:
109 | inventories:
110 | - https://docs.python.org/3/objects.inv
111 | paths: [src]
112 | options:
113 | docstring_options:
114 | ignore_init_summary: true
115 | docstring_section_style: list
116 | filters: ["!^_"]
117 | heading_level: 1
118 | inherited_members: true
119 | merge_init_into_class: true
120 | separate_signature: true
121 | show_root_heading: true
122 | show_root_full_path: false
123 | show_signature_annotations: true
124 | show_source: true
125 | show_symbol_type_heading: true
126 | show_symbol_type_toc: true
127 | signature_crossrefs: true
128 | summary: true
129 | - llmstxt:
130 | files:
131 | - output: llms-full.txt
132 | inputs:
133 | - index.md
134 | - reference/**.md
135 | - git-revision-date-localized:
136 | enabled: !ENV [DEPLOY, false]
137 | enable_creation_date: true
138 | type: timeago
139 | - minify:
140 | minify_html: !ENV [DEPLOY, false]
141 | - group:
142 | enabled: !ENV [MATERIAL_INSIDERS, false]
143 | plugins:
144 | - typeset
145 |
146 | extra:
147 | social:
148 | - icon: fontawesome/brands/github
149 | link: https://github.com/pawamoy
150 | - icon: fontawesome/brands/mastodon
151 | link: https://fosstodon.org/@pawamoy
152 | - icon: fontawesome/brands/twitter
153 | link: https://twitter.com/pawamoy
154 | - icon: fontawesome/brands/gitter
155 | link: https://gitter.im/copier-templates-extensions/community
156 | - icon: fontawesome/brands/python
157 | link: https://pypi.org/project/copier-templates-extensions/
158 | analytics:
159 | feedback:
160 | title: Was this page helpful?
161 | ratings:
162 | - icon: material/emoticon-happy-outline
163 | name: This page was helpful
164 | data: 1
165 | note: Thanks for your feedback!
166 | - icon: material/emoticon-sad-outline
167 | name: This page could be improved
168 | data: 0
169 | note: Let us know how we can improve this page.
170 |
--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
1 | [build-system]
2 | requires = ["pdm-backend"]
3 | build-backend = "pdm.backend"
4 |
5 | [project]
6 | name = "copier-templates-extensions"
7 | description = "Special Jinja2 extension for Copier that allows to load extensions using file paths relative to the template root instead of Python dotted paths."
8 | authors = [{name = "Timothée Mazzucotelli", email = "dev@pawamoy.fr"}]
9 | license = "ISC"
10 | license-files = ["LICENSE"]
11 | readme = "README.md"
12 | requires-python = ">=3.9"
13 | keywords = ["copier", "templates", "extension"]
14 | dynamic = ["version"]
15 | classifiers = [
16 | "Development Status :: 4 - Beta",
17 | "Intended Audience :: Developers",
18 | "Programming Language :: Python",
19 | "Programming Language :: Python :: 3",
20 | "Programming Language :: Python :: 3 :: Only",
21 | "Programming Language :: Python :: 3.9",
22 | "Programming Language :: Python :: 3.10",
23 | "Programming Language :: Python :: 3.11",
24 | "Programming Language :: Python :: 3.12",
25 | "Programming Language :: Python :: 3.13",
26 | "Programming Language :: Python :: 3.14",
27 | "Topic :: Software Development",
28 | "Topic :: Utilities",
29 | "Typing :: Typed",
30 | ]
31 | dependencies = [
32 | "copier>=9.2",
33 | ]
34 |
35 | [project.urls]
36 | Homepage = "https://github.com/copier-org/copier-templates-extensions"
37 | Documentation = "https://github.com/copier-org/copier-templates-extensions"
38 | Changelog = "https://github.com/copier-org/copier-templates-extensions/blob/main/CHANGELOG.md"
39 | Repository = "https://github.com/copier-org/copier-templates-extensions"
40 | Issues = "https://github.com/copier-org/copier-templates-extensions/issues"
41 | Discussions = "https://github.com/copier-org/copier-templates-extensions/discussions"
42 | Funding = "https://github.com/sponsors/pawamoy"
43 |
44 | [tool.pdm.version]
45 | source = "call"
46 | getter = "scripts.get_version:get_version"
47 |
48 | [tool.pdm.build]
49 | # Include as much as possible in the source distribution, to help redistributors.
50 | excludes = ["**/.pytest_cache"]
51 | source-includes = [
52 | "config",
53 | "docs",
54 | "scripts",
55 | "share",
56 | "tests",
57 | "duties.py",
58 | "mkdocs.yml",
59 | "*.md",
60 | "LICENSE",
61 | ]
62 |
63 | [tool.pdm.build.wheel-data]
64 | # Manual pages can be included in the wheel.
65 | # Depending on the installation tool, they will be accessible to users.
66 | # pipx supports it, uv does not yet, see https://github.com/astral-sh/uv/issues/4731.
67 | data = [
68 | {path = "share/**/*", relative-to = "."},
69 | ]
70 |
71 | [dependency-groups]
72 | maintain = [
73 | "build>=1.2",
74 | "git-changelog>=2.5",
75 | "twine>=5.1",
76 | "yore>=0.3.3",
77 | ]
78 | ci = [
79 | "duty>=1.6",
80 | "ruff>=0.4",
81 | "pytest>=8.2",
82 | "pytest-cov>=5.0",
83 | "pytest-randomly>=3.15",
84 | "pytest-xdist>=3.6",
85 | "mypy>=1.10",
86 | "types-markdown>=3.6",
87 | "types-pyyaml>=6.0",
88 | ]
89 | docs = [
90 | "markdown-callouts>=0.4",
91 | "markdown-exec>=1.8",
92 | "mkdocs>=1.6",
93 | "mkdocs-coverage>=1.0",
94 | "mkdocs-git-revision-date-localized-plugin>=1.2",
95 | "mkdocs-llmstxt>=0.1",
96 | "mkdocs-material>=9.5",
97 | "mkdocs-minify-plugin>=0.8",
98 | "mkdocs-section-index>=0.3",
99 | "mkdocstrings[python]>=0.25",
100 | # YORE: EOL 3.10: Remove line.
101 | "tomli>=2.0; python_version < '3.11'",
102 | ]
103 |
104 | [tool.uv]
105 | default-groups = ["maintain", "ci", "docs"]
106 |
--------------------------------------------------------------------------------
/scripts/gen_api_ref.py:
--------------------------------------------------------------------------------
1 | # Generate the API reference pages and navigation.
2 |
3 | from pathlib import Path
4 |
5 | import mkdocs_gen_files
6 |
7 | nav = mkdocs_gen_files.Nav()
8 | mod_symbol = '