10000 Merge pull request #1 from fluent-qa/feat/pdm-tpl · fluent-qa/fluentqa-pytpl@1f3d34b · GitHub
[go: up one dir, main page]
Skip to content

Commit 1f3d34b

Browse files
qdrivenqdriven
authored
Merge pull request #1 from fluent-qa/feat/pdm-tpl
init as pdm project
2 parents a4776d8 + 2aa2c3e commit 1f3d34b

File tree

91 files changed

+1411
-5264
lines changed

Some content is hidden

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

91 files changed

+1411
-5264
lines changed

‎.pdm-python

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/Users/patrick/workspace/personal/self-making/dev-stacks/daily-python/fluentqa-pytpl/.venv/bin/python

‎.pre-commit-config.yaml

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

‎.pre-commit-hooks.yaml

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

‎Makefile

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

‎README.md

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,18 @@
11
# README
22

3-
How to Use:
4-
5-
```shell
6-
cookiecutter https://github.com/fluent-qa/fluentqa-pytpl.git
7-
```
8-
9-
Follow the instruction to generate a template project.
3+
## PDM as Pythong Depencincy Manager
104

5+
- [PDM](https://pdm.fming.dev/)
6+
- [PDM 中文文档](https://pdm.fming.dev/zh_CN/latest/index.html)
117

128
## Templates
139

14-
1. [*] simple
15-
2. [*] cli-typer
16-
3. [*] cli-fire
17-
4. [*] server
18-
19-
## How to Create template
20-
21-
- cookiecutter based
22-
- generate files: hooks
23-
* post_gen_project.py
24-
* pre_gen_project.py
25-
26-
## References Template Project
10+
templates:
11+
- https://github.com/serious-scaffold/ss-python.git
12+
- https://github.com/TezRomacH/python-package-template.git
13+
- https://github.com/leynier/python-template.git
14+
- https://github.com/fpgmaas/cookiecutter-poetry.git
15+
- https://github.com/zillionare/cookiecutter-pypackage.git
16+
- https://github.com/rnag/cookiecutter-pypackage.git
17+
- https://github.com/yxtay/python-project-template.git
2718

28-
- [fastapi-starter]( https://github.com/gaganpreet/fastapi-starter.git)

‎copier-pdm

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Subproject commit adff9b64887d0b4c9ec0b42de1698b34858a511e

‎copier.yaml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
_envops:
2+
block_end_string: '%]'
3+
block_start_string: '[%'
4+
_subdirectory: template
5+
_message_before_copy: |
6+
Thanks for generating a project using our template.
7+
8+
You'll be asked a series of questions whose answers will be used to
9+
generate a tailored project for you.
10+
_message_after_copy: |
11+
Your project "{{ project_name }}" has been created successfully!
12+
_message_before_update: |
13+
Thanks for updating your project using our template.
14+
15+
You'll be asked a series of questions whose answers are pre-populated
16+
with previously entered values. Feel free to change them as needed.
17+
_message_after_update: |
18+
Your project "{{ project_name }}" has been updated successfully!
19+
In case there are any conflicts, please resolve them. Then,
20+
you're done.
21+
project_name:
22+
default: My Project
23+
help: 'Enter the name of the project in CamelCase format:'
24+
type: str
25+
project_description:
26+
default: Project brief description.
27+
help: "Provide a concise description to be used in the Python package overview and the introductory paragraph in the README and documentation's index page:"
28+
type: str
29+
development_status:
30+
default: Alpha
31+
choices:
32+
- Alpha
33+
- Beta
34+
- Production/Stable
35+
help: 'Choose the development status:'
36+
type: str
37+
38+
author_name:
39+
default: Your Name
40+
help: 'Specify the name of the author:'
41+
type: str
42+
organization_name:
43+
default: Your Organization Name
44+
help: 'Provide the name of the organization associated with the project:'
45+
type: str
46+
copyright_holder:
47+
default: '{{ organization_name }}'
48+
help: Name(s) or organization(s) holding the copyright.
49+
type: str
50+
author_email:
51+
default: '{{ author_name|lower|replace(" ", ".") }}@{{ organization_name|lower|replace(" ", "-") }}.com'
52+
help: 'Specify the email address of the author:'
53+
type: str
54+
55+
repo_namespace:
56+
default: '{{ organization_name|lower|replace(" ", "-") }}'
57+
help: 'Indicate the GitHub Repository Owner or GitLab Namespace. This is typically the account name of the author or the organization:'
58+
type: str
59+
repo_name:
60+
default: '{{ project_name|lower|replace(" ", "-") }}'
61+
help: 'Provide a name for the repository:'
62+
type: str
63+
package_name:
64+
default: '{{ repo_name|regex_replace("-python$", "") }}'
65+
help: 'Specify the name of the distributable package for the project (often used in "pip install <package_name>"):'
66+
type: str
67+
module_name:
68+
default: '{{ package_name|lower|replace("-", "_") }}'
69+
help: 'Specify the name of the primary module within the package (often used in "import <module_name>"):'
70+
type: str

‎docs/create/create-doc-site/index.md

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

0 commit comments

Comments
 (0)
0