Skip to content

Commit 7e612c0

Browse files
committed
Initial commit
0 parents  commit 7e612c0

26 files changed

+1454
-0
lines changed

.copier-answers.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changes here will be overwritten by Copier
2+
_commit: b6bd6c7
3+
_src_path: [email protected]:python-project-templates/base.git
4+
add_extension: python
5+
6+
github: python-project-templates
7+
project_description: Hatch plugin for C++ builds
8+
project_name: hatch cpp
9+
python_version_primary: '3.11'
10+
team: the hatch-cpp authors

.gitattributes

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
examples/* linguist-documentation
2+
docs/* linguist-documentation
3+
*.ipynb linguist-documentation
4+
Makefile linguist-documentation
5+
6+
* text=auto eol=lf

.github/CODE_OF_CONDUCT.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

.github/ISSUE_TEMPLATE/bug_report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
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. Click on '....'
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+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
+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: ''
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/dependabot.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
labels:
8+
- "part: github_actions"
9+
10+
- package-ecosystem: "pip"
11+
directory: "/"
12+
schedule:
13+
interval: "monthly"
14+
labels:
15+
- "lang: python"
16+
- "part: dependencies"
17+
18+
- package-ecosystem: "npm"
19+
directory: "/"
20+
schedule:
21+
interval: "monthly"
22+
labels:
23+
- "lang: javascript"
24+
- "part: dependencies"

.github/workflows/build.yml

+129
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
name: Build Status
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
tags:
8+
- v*
9+
paths-ignore:
10+
- docs/
11+
- LICENSE
12+
- README.md
13+
pull_request:
14+
workflow_dispatch:
15+
16+
concurrency:
17+
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
18+
cancel-in-progress: true
19+
20+
permissions:
21+
contents: write
22+
checks: write
23+
pull-requests: write
24+
25+
jobs:
26+
build:
27+
runs-on: ${{ matrix.os }}
28+
29+
strategy:
30+
matrix:
31+
# os: [ubuntu-latest, macos-latest, windows-latest]
32+
os: [ubuntu-latest, macos-latest]
33+
python-version: [3.9, 3.11]
34+
node-version: [18.x]
35+
36+
steps:
37+
- uses: actions/checkout@v4
38+
39+
- name: Set up Python ${{ matrix.python-version }}
40+
uses: actions/setup-python@v5
41+
with:
42+
python-version: ${{ matrix.python-version }}
43+
cache: "pip"
44+
cache-dependency-path: 'pyproject.toml'
45+
46+
- name: Install pandoc via brew
47+
run: brew install pandoc
48+
if: ${{ matrix.os == 'macos-latest' }}
49+
50+
- name: Install pandoc via apt
51+
run: sudo apt install pandoc
52+
if: ${{ matrix.os == 'ubuntu-latest' }}
53+
54+
- name: Install pnpm
55+
uses: pnpm/action-setup@v4
56+
with:
57+
version: 9
58+
package_json_file: js/package.json
59+
60+
- name: Install dependencies
61+
run: make develop
62+
63+
- name: Build
64+
run: make build
65+
66+
- name: Lint
67+
run: make lint
68+
69+
- name: Test
70+
run: make tests
71+
if: ${{ matrix.os == 'ubuntu-latest' }}
72+
73+
- name: Upload test results (Python)
74+
uses: actions/upload-artifact@v4
75+
with:
76+
name: py-test-results-${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.node-version}}
77+
path: junit.xml
78+
if: ${{ matrix.os == 'ubuntu-latest' }}
79+
80+
- name: Upload test results (JS)
81+
uses: actions/upload-artifact@v4
82+
with:
83+
name: js-test-results-${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.node-version}}
84+
path: js/junit.xml
85+
if: ${{ matrix.os == 'ubuntu-latest' }}
86+
87+
- name: Publish Unit Test Results
88+
uses: EnricoMi/publish-unit-test-result-action@v2
89+
with:
90+
files: |
91+
**/junit.xml
92+
if: ${{ matrix.os == 'ubuntu-latest' }}
93+
94+
- name: Upload coverage
95+
uses: codecov/codecov-action@v4
96+
97+
- name: Upload generated reports
98+
uses: actions/upload-artifact@v4
99+
id: upload-reports
100+
with:
101+
name: reports
102+
path: 'examples/output/*.html'
103+
if-no-files-found: error
104+
overwrite: true
105+
if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.11 && github.event_name == 'pull_request'
106+
107+
- name: Find comment for generated reports
108+
uses: peter-evans/find-comment@v3
109+
id: find-comment
110+
with:
111+
issue-number: ${{ github.event.pull_request.number }}
112+
comment-author: 'github-actions[bot]'
113+
if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.11 && github.event_name == 'pull_request'
114+
115+
- name: Update comment for generated reports
116+
uses: peter-evans/create-or-update-comment@v4
117+
with:
118+
issue-number: ${{ github.event.pull_request.number }}
119+
comment-id: ${{ steps.find-comment.outputs.comment-id }}
120+
edit-mode: replace
121+
body: |-
122+
| Name | Link |
123+
| -------- | ----------------------- |
124+
| Test Reports | [download](${{ steps.upload-reports.outputs.artifact-url }}) |
125+
if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.11 && github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'nbprint/nbprint'
126+
127+
- name: Twine check
128+
run: make dist
129+

0 commit comments

Comments
 (0)