-
-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Generate project from copier-pdm template
- Loading branch information
0 parents
commit 7ea73ad
Showing
38 changed files
with
1,424 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Changes here will be overwritten by Copier | ||
_commit: 0.4.3 | ||
_src_path: gh:pawamoy/copier-pdm | ||
author_email: pawamoy@pm.me | ||
author_fullname: "Timoth\xE9e Mazzucotelli" | ||
author_username: pawamoy | ||
copyright_date: '2021' | ||
copyright_holder: "Timoth\xE9e Mazzucotelli" | ||
copyright_holder_email: pawamoy@pm.me | ||
copyright_license: ISC License | ||
project_description: Signatures for entire Python programs. Extract the structure, | ||
the frame, the skeleton of your project, to generate API documentation or find breaking | ||
changes in your API. | ||
project_name: griffe | ||
python_package_command_line_name: griffe | ||
python_package_distribution_name: griffe | ||
python_package_import_name: griffe | ||
repository_name: griffe | ||
repository_namespace: pawamoy | ||
repository_provider: github.com | ||
use_precommit: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
github: | ||
- pawamoy | ||
ko_fi: pawamoy | ||
liberapay: pawamoy | ||
patreon: pawamoy | ||
custom: | ||
- https://www.paypal.me/pawamoy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: unconfirmed | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Run command '...' | ||
3. Scroll down to '...' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**System (please complete the following information):** | ||
- `griffe` version: [e.g. 0.2.1] | ||
- Python version: [e.g. 3.8] | ||
- OS: [Windows/Linux] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: feature | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
name: ci | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
pull_request: | ||
branches: | ||
- master | ||
|
||
defaults: | ||
run: | ||
shell: bash | ||
|
||
env: | ||
LANG: en_US.utf-8 | ||
LC_ALL: en_US.utf-8 | ||
PYTHONIOENCODING: UTF-8 | ||
|
||
jobs: | ||
|
||
quality: | ||
|
||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up PDM | ||
uses: pdm-project/setup-pdm@v2 | ||
with: | ||
python-version: 3.8 | ||
|
||
- name: Set cache variables | ||
id: set_variables | ||
run: | | ||
echo "::set-output name=PIP_CACHE::$(pip cache dir)" | ||
echo "::set-output name=PDM_CACHE::$(pdm config cache_dir)" | ||
- name: Set up cache | ||
uses: actions/cache@v2 | ||
with: | ||
path: | | ||
${{ steps.set_variables.outputs.PIP_CACHE }} | ||
${{ steps.set_variables.outputs.PDM_CACHE }} | ||
key: checks-cache | ||
|
||
- name: Resolving dependencies | ||
run: pdm lock | ||
|
||
- name: Install dependencies | ||
run: | | ||
pdm install -G duty -G docs -G quality -G typing | ||
pip install safety | ||
- name: Check if the documentation builds correctly | ||
run: pdm run duty check-docs | ||
|
||
- name: Check the code quality | ||
run: pdm run duty check-code-quality | ||
|
||
- name: Check if the code is correctly typed | ||
run: pdm run duty check-types | ||
|
||
- name: Check for vulnerabilities in dependencies | ||
run: pdm run duty check-dependencies | ||
|
||
tests: | ||
|
||
strategy: | ||
matrix: | ||
os: [ubuntu-latest, macos-latest, windows-latest] | ||
python-version: [3.6, 3.7, 3.8, 3.9] | ||
|
||
runs-on: ${{ matrix.os }} | ||
|
||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up PDM | ||
uses: pdm-project/setup-pdm@v2 | ||
with: | ||
python-version: ${{ matrix.python-version }} | ||
|
||
- name: Set cache variables | ||
id: set_variables | ||
run: | | ||
echo "::set-output name=PIP_CACHE::$(pip cache dir)" | ||
echo "::set-output name=PDM_CACHE::$(pdm config cache_dir)" | ||
- name: Set up cache | ||
uses: actions/cache@v2 | ||
with: | ||
path: | | ||
${{ steps.set_variables.outputs.PIP_CACHE }} | ||
${{ steps.set_variables.outputs.PDM_CACHE }} | ||
key: tests-cache-${{ runner.os }}-${{ matrix.python-version }} | ||
|
||
- name: Install dependencies | ||
run: pdm install -G duty -G tests | ||
|
||
- name: Run the test suite | ||
run: pdm run duty test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
.idea/ | ||
__pycache__/ | ||
*.py[cod] | ||
dist/ | ||
*.egg-info/ | ||
build/ | ||
htmlcov/ | ||
.coverage* | ||
pip-wheel-metadata/ | ||
.pytest_cache/ | ||
.mypy_cache/ | ||
site/ | ||
pdm.lock | ||
.pdm.toml | ||
__pypackages__/ | ||
.venv/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Changelog | ||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) | ||
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). | ||
|
||
<!-- insertion marker --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at pawamoy@pm.me. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
Oops, something went wrong.