Skip to content

Commit 4b2335e

Browse files
pawamoypawamoy
committed
feat: Generate project using pawamoy/copier-pdm template
0 parents  commit 4b2335e

40 files changed

+1512
-0
lines changed

‎.copier-answers.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Changes here will be overwritten by Copier
2+
_commit: 0.8.1
3+
_src_path: gh:pawamoy/copier-pdm
4+
author_email: [email protected]
5+
author_fullname: Timothée Mazzucotelli
6+
author_username: pawamoy
7+
copyright_date: '2022'
8+
copyright_holder: Timothée Mazzucotelli
9+
copyright_holder_email: [email protected]
10+
copyright_license: ISC License
11+
project_description: A spell checker plugin for MkDocs.
12+
project_name: MkDocs SpellCheck
13+
python_package_command_line_name: ''
14+
python_package_distribution_name: mkdocs-spellcheck
15+
python_package_import_name: mkdocs_spellcheck
16+
repository_name: mkdocs-spellcheck
17+
repository_namespace: pawamoy
18+
repository_provider: github.com
19+
use_precommit: false
20+

‎.github/FUNDING.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
github:
2+
- pawamoy
3+
ko_fi: pawamoy
4+
liberapay: pawamoy
5+
patreon: pawamoy
6+
custom:
7+
- https://www.paypal.me/pawamoy

‎.github/ISSUE_TEMPLATE/bug_report.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: unconfirmed
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Run command '...'
17+
3. Scroll down to '...'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**System (please complete the following information):**
27+
- `MkDocs SpellCheck` version: [e.g. 0.2.1]
28+
- Python version: [e.g. 3.8]
29+
- OS: [Windows/Linux]
30+
31+
**Additional context**
32+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: feature
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/workflows/ci.yml

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
name: ci
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- master
10+
11+
defaults:
12+
run:
13+
shell: bash
14+
15+
env:
16+
LANG: en_US.utf-8
17+
LC_ALL: en_US.utf-8
18+
PYTHONIOENCODING: UTF-8
19+
20+
jobs:
21+
22+
quality:
23+
24+
runs-on: ubuntu-latest
25+
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v2
29+
30+
- name: Set up PDM
31+
uses: pdm-project/[email protected]
32+
with:
33+
python-version: "3.8"
34+
35+
- name: Set cache variables
36+
id: set_variables
37+
run: |
38+
echo "::set-output name=PIP_CACHE::$(pip cache dir)"
39+
echo "::set-output name=PDM_CACHE::$(pdm config cache_dir)"
40+
41+
- name: Set up cache
42+
uses: actions/cache@v2
43+
with:
44+
path: |
45+
${{ steps.set_variables.outputs.PIP_CACHE }}
46+
${{ steps.set_variables.outputs.PDM_CACHE }}
47+
key: checks-cache
48+
49+
- name: Resolving dependencies
50+
run: pdm lock
51+
52+
- name: Install dependencies
53+
run: pdm install -G duty -G docs -G quality -G typing -G security
54+
55+
- name: Check if the documentation builds correctly
56+
run: pdm run duty check-docs
57+
58+
- name: Check the code quality
59+
run: pdm run duty check-quality
60+
61+
- name: Check if the code is correctly typed
62+
run: pdm run duty check-types
63+
64+
- name: Check for vulnerabilities in dependencies
65+
run: pdm run duty check-dependencies
66+
67+
tests:
68+
69+
strategy:
70+
matrix:
71+
os:
72+
- ubuntu-latest
73+
- macos-latest
74+
- windows-latest
75+
python-version:
76+
- "3.7"
77+
- "3.8"
78+
- "3.9"
79+
- "3.10"
80+
- "3.11-dev"
81+
82+
runs-on: ${{ matrix.os }}
83+
84+
steps:
85+
- name: Checkout
86+
uses: actions/checkout@v2
87+
88+
- name: Set up PDM
89+
uses: pdm-project/[email protected]
90+
with:
91+
python-version: ${{ matrix.python-version }}
92+
93+
- name: Set cache variables
94+
id: set_variables
95+
run: |
96+
echo "::set-output name=PIP_CACHE::$(pip cache dir)"
97+
echo "::set-output name=PDM_CACHE::$(pdm config cache_dir)"
98+
99+
- name: Set up cache
100+
uses: actions/cache@v2
101+
with:
102+
path: |
103+
${{ steps.set_variables.outputs.PIP_CACHE }}
104+
${{ steps.set_variables.outputs.PDM_CACHE }}
105+
key: tests-cache-${{ runner.os }}-${{ matrix.python-version }}
106+
107+
- name: Install dependencies
108+
run: pdm install -G duty -G tests
109+
110+
- name: Run the test suite
111+
run: pdm run duty test

‎.gitignore

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.idea/
2+
__pycache__/
3+
*.py[cod]
4+
dist/
5+
*.egg-info/
6+
build/
7+
htmlcov/
8+
.coverage*
9+
pip-wheel-metadata/
10+
.pytest_cache/
11+
.mypy_cache/
12+
site/
13+
pdm.lock
14+
.pdm.toml
15+
__pypackages__/
16+
.venv/

‎.gitpod.dockerfile

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
FROM gitpod/workspace-full
2+
USER gitpod
3+
ENV PIP_USER=no
4+
ENV PYTHON_VERSIONS=
5+
RUN pip3 install pipx; \
6+
pipx install pdm; \
7+
pipx ensurepath

‎.gitpod.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
vscode:
2+
extensions:
3+
- ms-python.python
4+
5+
image:
6+
file: .gitpod.dockerfile
7+
8+
ports:
9+
- port: 8000
10+
onOpen: notify
11+
12+
tasks:
13+
- init: make setup

‎CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6+
7+
<!-- insertion marker -->

‎CODE_OF_CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

0 commit comments

Comments
 (0)