Skip to content

Commit 2fa8bc2

Browse files
timkpainetimkpaine
committed
initializing library from template
1 parent 7a9c28a commit 2fa8bc2

20 files changed

+765
-83
lines changed

‎.bumpversion.cfg

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[bumpversion]
2+
current_version = 0.1.0
3+
commit = True
4+
tag = True
5+
6+
[bumpversion:file:pyproject_cookiecutter_example/_version.py]
7+
search = __version__ = "{current_version}"
8+
replace = __version__ = "{new_version}"
9+
10+
11+
[bumpversion:file:pyproject.toml]
12+
search = version="{current_version}"
13+
replace = version="{new_version}"
14+
15+
[bumpversion:file:setup.py]
16+
search = version="{current_version}"
17+
replace = version="{new_version}"

‎.gitattributes

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

‎.github/CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

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

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

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"

‎.github/workflows/build.yml

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: Build Status
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
# NOTE: can delete these, used by CI
8+
- python
9+
- cpp
10+
- js
11+
- jupyter
12+
- rust
13+
tags:
14+
- v*
15+
paths-ignore:
16+
- docs/
17+
- CONTRIBUTING.md
18+
- LICENSE
19+
- README.md
20+
pull_request:
21+
branches:
22+
- main
23+
workflow_dispatch:
24+
25+
concurrency:
26+
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
27+
cancel-in-progress: true
28+
29+
permissions:
30+
content: read
31+
checks: write
32+
pull-requests: write
33+
34+
jobs:
35+
build:
36+
runs-on: ${{ matrix.os }}
37+
38+
strategy:
39+
matrix:
40+
os: [ubuntu-latest]
41+
python-version: [3.9]
42+
43+
steps:
44+
- uses: actions/checkout@v3
45+
46+
- name: Set up Python ${{ matrix.python-version }}
47+
uses: actions/setup-python@v4
48+
with:
49+
python-version: ${{ matrix.python-version }}
50+
cache: 'pip'
51+
cache-dependency-path: 'setup.py'
52+
53+
- name: Install dependencies
54+
run: |
55+
make develop
56+
57+
- name: Lint
58+
run: |
59+
make lint
60+
if: ${{ matrix.os == 'ubuntu-latest' }}
61+
62+
- name: Checks
63+
run: |
64+
make checks
65+
if: ${{ matrix.os == 'ubuntu-latest' }}
66+
67+
- name: Build
68+
run: |
69+
make build
70+
71+
- name: Test
72+
run: |
73+
make tests
74+
if: ${{ matrix.os == 'ubuntu-latest' }}
75+
76+
- name: Upload test results
77+
uses: actions/upload-artifact@v3
78+
with:
79+
name: pytest-results-${{ matrix.os }}-${{ matrix.python-version }}
80+
path: python_junit.xml
81+
if: ${{ always() }}
82+
83+
- name: Publish Unit Test Results
84+
uses: EnricoMi/publish-unit-test-result-action@v1
85+
with:
86+
files: python_junit.xml
87+
if: ${{ matrix.os == 'ubuntu-latest' }}
88+
89+
- name: Upload coverage
90+
uses: codecov/codecov-action@v3

‎.github/workflows/publish.yml

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Publish
2+
3+
on:
4+
push:
5+
branches:
6+
# NOTE: can delete these, used by CI
7+
- python
8+
- cpp
9+
- js
10+
- jupyter
11+
- rust
12+
tags:
13+
- v*
14+
15+
concurrency:
16+
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
17+
cancel-in-progress: true
18+
19+
jobs:
20+
dist:
21+
runs-on: ${{ matrix.os }}
22+
23+
strategy:
24+
fail-fast: false
25+
matrix:
26+
os: [ubuntu-latest]
27+
28+
steps:
29+
- uses: actions/checkout@v3
30+
31+
- name: Set up Python ${{ matrix.python-version }}
32+
uses: actions/setup-python@v4
33+
with:
34+
python-version: 3.9
35+
cache: 'pip'
36+
cache-dependency-path: 'setup.py'
37+
38+
- name: Install dependencies
39+
run: |
40+
make develop
41+
- name: Make python dist
42+
run: |
43+
make dist-py
44+
if: ${{ matrix.os == 'ubuntu-latest' }}
45+
46+
- uses: actions/upload-artifact@v3
47+
with:
48+
path: ./dist/*.tar.gz
49+
if: ${{ matrix.os == 'ubuntu-latest' }}
50+
51+
- uses: actions/upload-artifact@v3
52+
with:
53+
path: ./dist/*.whl

0 commit comments

Comments
 (0)