Skip to content

Commit 4e48d1d

Browse files
committed
chore: Template upgrade
1 parent eef2661 commit 4e48d1d

35 files changed

Lines changed: 375 additions & 476 deletions

‎.copier-answers.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changes here will be overwritten by Copier.
2-
_commit: 1.11.1
2+
_commit: 1.12.1
33
_src_path: gh:pawamoy/copier-uv
44
author_email: dev@pawamoy.fr
55
author_fullname: Timothée Mazzucotelli

‎.github/workflows/ci.yml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,11 @@ jobs:
4343
python-version: "3.12"
4444
- os: ubuntu-latest
4545
python-version: "3.13"
46+
- os: ubuntu-latest
47+
python-version: "3.15-dev"
4648

4749
runs-on: ${{ matrix.os }}
50+
continue-on-error: true
4851

4952
steps:
5053
- name: Checkout
@@ -110,7 +113,7 @@ jobs:
110113
- "3.12"
111114
- "3.13"
112115
- "3.14"
113-
- "3.15"
116+
- "3.15-dev"
114117
resolution:
115118
- highest
116119
- lowest-direct
@@ -119,6 +122,7 @@ jobs:
119122
resolution: lowest-direct
120123
- os: windows-latest
121124
resolution: lowest-direct
125+
122126
runs-on: ${{ matrix.os }}
123127
continue-on-error: true
124128

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,5 @@ uv.lock
2020
# cache
2121
.cache/
2222
.pytest_cache/
23-
.mypy_cache/
2423
.ruff_cache/
2524
__pycache__/

‎AI_POLICY.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# AI Contribution Policy
2+
3+
We accept AI-*assisted* contributions, both for code and documentation, with the following expectations:
4+
5+
- AI-assisted contributions must disclaim their use of AI.
6+
- Contributors must fully understand the proposed changes and be able to explain why they are the correct approach.
7+
- Issues must be created before creating pull requests (unless there is already a relevant issue).
8+
- Issue and pull request templates must be followed.
9+
- Comments (including bodies) in issues and pull requests must be written by humans. If you use LLMs to translate from one language to another, please include your original comment and the translated one.
10+
- Git commits must be authored by humans, not AI/bot accounts or identities.
11+
- Git commit messages must be written by humans, in English. If you cannot write English, please state so in the pull request body and we will write the commit messages ourselves.
12+
13+
Failure to comply with any of these requirements will result in issues or pull requests being closed immediately without comment. Repeated violations of this policy will result in a ban of the offending accounts/identities from contributing to this project and any related project from the same author/organization.
14+
15+
We do not accept AI-generated content in community spaces we maintain or moderate, such as GitHub discussions or Matrix rooms.

‎CONTRIBUTING.md‎

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,26 @@
11
# Contributing
22

3-
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
3+
Contributions are welcome, and they are greatly appreciated. Every little bit helps, and credit will always be given.
44

5-
## Environment setup
5+
**Please always create an issue before working on a new feature or a bug fix, so that we can discuss the implementation and make sure that your work will be merged.**
66

7-
Nothing easier!
7+
## Environment setup
88

9-
Fork and clone the repository, then:
9+
Install [uv](https://github.com/astral-sh/uv) and [direnv](https://direnv.net/), fork and clone the repository, then:
1010

1111
```bash
1212
cd markdown-exec
13+
direnv allow
1314
make setup
1415
```
1516

16-
> NOTE: If it fails for some reason, you'll need to install [uv](https://github.com/astral-sh/uv) manually.
17-
>
18-
> You can install it with:
19-
>
20-
> ```bash
21-
> curl -LsSf https://astral.sh/uv/install.sh | sh
22-
> ```
23-
>
24-
> Now you can try running `make setup` again, or simply `uv sync`.
25-
2617
You now have the dependencies installed.
2718

2819
Run `make help` to see all the available actions!
2920

3021
## Tasks
3122

32-
The entry-point to run commands and tasks is the `make` Python script, located in the `scripts` directory. Try running `make` to show the available commands and tasks. The *commands* do not need the Python dependencies to be installed,
33-
while the *tasks* do. The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
23+
The entry-point to run commands and tasks is the `make` Python script, located in the `scripts` directory. Try running `make` to show the available commands and tasks. The *commands* do not need the Python dependencies to be installed, while the *tasks* do. The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
3424

3525
If you work in VSCode, we provide [an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup) for the project.
3626

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ISC License
22

3-
Copyright (c) 2022, Timothée Mazzucotelli
3+
Copyright (c) 2022, Timothée Mazzucotelli and contributors
44

55
Permission to use, copy, modify, and/or distribute this software for any
66
purpose with or without fee is hereby granted, provided that the above

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Markdown Exec
22

33
[![ci](https://github.com/pawamoy/markdown-exec/workflows/ci/badge.svg)](https://github.com/pawamoy/markdown-exec/actions?query=workflow%3Aci)
4-
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/markdown-exec/)
4+
[![documentation](https://img.shields.io/badge/docs-zensical-FF9100.svg?style=flat)](https://pawamoy.github.io/markdown-exec/)
55
[![pypi version](https://img.shields.io/pypi/v/markdown-exec.svg)](https://pypi.org/project/markdown-exec/)
66
[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#markdown-exec:gitter.im)
77
[![radicle](https://img.shields.io/badge/rad-clone-6666FF.svg?style=flat)](https://app.radicle.at/nodes/seed.radicle.at/rad:z77aiLJkzYXtuNpZuvizfGkDuZbQ)

‎config/mypy.ini‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎config/ruff.toml‎

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,33 @@
1-
target-version = "py39"
1+
target-version = "py310"
22
line-length = 120
3+
output-format = "concise"
34

45
[lint]
56
exclude = [
67
"tests/fixtures/*.py",
78
]
8-
select = [
9-
"A", "ANN", "ARG",
10-
"B", "BLE",
11-
"C", "C4",
12-
"COM",
13-
"D", "DTZ",
14-
"E", "ERA", "EXE",
15-
"F", "FBT",
16-
"G",
17-
"I", "ICN", "INP", "ISC",
18-
"N",
19-
"PGH", "PIE", "PL", "PLC", "PLE", "PLR", "PLW", "PT", "PYI",
20-
"Q",
21-
"RUF", "RSE", "RET",
22-
"S", "SIM", "SLF",
23-
"T", "T10", "T20", "TCH", "TID", "TRY",
24-
"UP",
25-
"W",
26-
"YTT",
27-
]
9+
select = ["ALL"]
2810
ignore = [
2911
"A001", # Variable is shadowing a Python builtin
30-
"ANN101", # Missing type annotation for self
31-
"ANN102", # Missing type annotation for cls
3212
"ANN204", # Missing return type annotation for special method __str__
3313
"ANN401", # Dynamically typed expressions (typing.Any) are disallowed
3414
"ARG005", # Unused lambda argument
3515
"C901", # Too complex
3616
"D105", # Missing docstring in magic method
3717
"D417", # Missing argument description in the docstring
3818
"E501", # Line too long
19+
"EM101", # String literal when raising exception
20+
"EM102", # f-string when raising exception
3921
"ERA001", # Commented out code
22+
"FIX", # TODO, FIXME, etc.
4023
"G004", # Logging statement uses f-string
4124
"PLR0911", # Too many return statements
4225
"PLR0912", # Too many branches
4326
"PLR0913", # Too many arguments to function call
4427
"PLR0915", # Too many statements
45-
"SLF001", # Private member accessed
28+
"SLF001", # Private member accessed
29+
"TD002", # Missing author in TODO
30+
"TD003", # Missing issue link for TODO
4631
"TRY003", # Avoid specifying long messages outside the exception class
4732
]
4833

‎config/ty.toml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[src]
2+
exclude = ["tests/fixtures"]
3+
4+
[terminal]
5+
error-on-warning = true
6+
output-format = "concise"

0 commit comments

Comments
 (0)