Skip to content

Commit a018851

Browse files
pawamoypawamoy
committed
feat: Generate project using copier-pdm template
1 parent 39a8547 commit a018851

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+2316
-2
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.15.10
3+
_src_path: gh:pawamoy/copier-pdm
4+
author_email: pawamoy@pm.me
5+
author_fullname: Timothée Mazzucotelli
6+
author_username: pawamoy
7+
copyright_date: '2023'
8+
copyright_holder: Timothée Mazzucotelli
9+
copyright_holder_email: pawamoy@pm.me
10+
copyright_license: ISC License
11+
insiders: true
12+
project_description: MkDocs plugin to generate a manpage from the documentation site.
13+
project_name: MkDocs Manpage
14+
python_package_command_line_name: ''
15+
python_package_distribution_name: mkdocs-manpage
16+
python_package_import_name: mkdocs_manpage
17+
repository_name: mkdocs-manpage
18+
repository_namespace: pawamoy
19+
repository_provider: github.com
20+

‎.github/FUNDING.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
github: pawamoy
2+
ko_fi: pawamoy
3+
custom:
4+
- 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 Manpage` 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

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
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@v3
29+
30+
- name: Set up PDM
31+
uses: pdm-project/setup-pdm@v3
32+
with:
33+
python-version: "3.8"
34+
35+
- name: Resolving dependencies
36+
run: pdm lock -v --no-cross-platform -G ci-quality
37+
38+
- name: Install dependencies
39+
run: pdm install -G ci-quality
40+
41+
- name: Check if the documentation builds correctly
42+
run: pdm run duty check-docs
43+
44+
- name: Check the code quality
45+
run: pdm run duty check-quality
46+
47+
- name: Check if the code is correctly typed
48+
run: pdm run duty check-types
49+
50+
- name: Check for vulnerabilities in dependencies
51+
run: pdm run duty check-dependencies
52+
53+
- name: Check for breaking changes in the API
54+
run: pdm run duty check-api
55+
56+
exclude-test-jobs:
57+
runs-on: ubuntu-latest
58+
outputs:
59+
jobs: ${{ steps.exclude-jobs.outputs.jobs }}
60+
steps:
61+
- id: exclude-jobs
62+
run: |
63+
if ${{ github.repository_owner == 'pawamoy-insiders' }}; then
64+
echo 'jobs=[
65+
{"os": "macos-latest"},
66+
{"os": "windows-latest"},
67+
{"python-version": "3.8"},
68+
{"python-version": "3.9"},
69+
{"python-version": "3.10"},
70+
{"python-version": "3.11"}
71+
]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
72+
else
73+
echo 'jobs=[]' >> $GITHUB_OUTPUT
74+
fi
75+
76+
tests:
77+
78+
needs: exclude-test-jobs
79+
strategy:
80+
max-parallel: 4
81+
matrix:
82+
os:
83+
- ubuntu-latest
84+
- macos-latest
85+
- windows-latest
86+
python-version:
87+
- "3.7"
88+
- "3.8"
89+
- "3.9"
90+
- "3.10"
91+
- "3.11"
92+
exclude: ${{ fromJSON(needs.exclude-test-jobs.outputs.jobs) }}
93+
94+
runs-on: ${{ matrix.os }}
95+
96+
steps:
97+
- name: Checkout
98+
uses: actions/checkout@v3
99+
100+
- name: Set up PDM
101+
uses: pdm-project/setup-pdm@v3
102+
with:
103+
python-version: ${{ matrix.python-version }}
104+
105+
- name: Resolving dependencies
106+
run: pdm lock -v --no-cross-platform -G ci-tests
107+
108+
- name: Install dependencies
109+
run: pdm install --no-editable -G ci-tests
110+
111+
- name: Run the test suite
112+
run: pdm run duty test

‎.github/workflows/dists.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: dists
2+
3+
on: push
4+
permissions:
5+
contents: write
6+
7+
jobs:
8+
build:
9+
name: Build dists
10+
runs-on: ubuntu-latest
11+
if: github.repository_owner == 'pawamoy-insiders'
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v3
15+
with:
16+
fetch-depth: 0
17+
- name: Setup Python
18+
uses: actions/setup-python@v3
19+
- name: Install build
20+
run: python -m pip install build
21+
- name: Build dists
22+
run: python -m build
23+
- name: Upload dists artifact
24+
uses: actions/upload-artifact@v3
25+
with:
26+
name: mkdocs-manpage-insiders
27+
path: ./dist/*
28+
- name: Create release and upload assets
29+
uses: softprops/action-gh-release@v1
30+
if: startsWith(github.ref, 'refs/tags/')
31+
with:
32+
files: ./dist/*

‎.gitignore

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
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+
.pdm-plugins/
16+
.pdm-python
17+
__pypackages__/
18+
.venv/
19+
.cache/

‎.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

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

0 commit comments

Comments
 (0)