Skip to content

Commit c28723f

Browse files
tobiasraabetobiasraabe
authored
Convert template to cookiecutter. (#1)
1 parent 71feceb commit c28723f

Some content is hidden

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

68 files changed

+2621
-826
lines changed

‎.conda/meta.yaml

-49
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
22

33
name: Bug Report
4-
about: Create a bug report to help us improve pytask-xxxxx
4+
about: Create a bug report to help us improve cookiecutter-pytask
55
title: "BUG:"
66
labels: "bug"
77

88
---
99

1010
- [ ] I have checked that this issue has not already been reported.
1111

12-
- [ ] I have confirmed this bug exists on the latest version of pytask-xxxxx.
12+
- [ ] I have confirmed this bug exists on the latest version of cookiecutter-pytask.
1313

1414
- [ ] (optional) I have confirmed this bug exists on the `main` branch of
15-
pytask-xxxxx.
15+
cookiecutter-pytask.
1616

1717
---
1818

‎.github/ISSUE_TEMPLATE/documentation.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,7 @@ labels: "documentation"
99

1010
#### Location of the documentation
1111

12-
Provide the location of the documentation, e.g. an URL of the documentation.
13-
14-
**Note**: You can check the latest versions of the docs on `main`
15-
[here](https://pytask-xxxxx.readthedocs.io/en/latest).
12+
Provide the location of the documentation, e.g. an URL to a section of the readme.
1613

1714
#### Documentation problem
1815

‎.github/ISSUE_TEMPLATE/enhancement.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22

33
name: Enhancement
4-
about: Suggest an idea for pytask-xxxxx
4+
about: Suggest an idea for cookiecutter-pytask
55
title: "ENH:"
66
labels: "enhancement"
77

88
---
99

1010
#### Is your feature request related to a problem?
1111

12-
Provide a description of what the problem is, e.g. "I wish I could use pytask-xxxxx
13-
to do [...]".
12+
Provide a description of what the problem is, e.g. "I wish I could use
13+
cookiecutter-pytask to do [...]".
1414

1515
#### Describe the solution you'd like
1616

‎.github/ISSUE_TEMPLATE/question.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22

33
name: Submit Question
4-
about: Ask a general question about pytask-xxxxx
4+
about: Ask a general question about cookiecutter-pytask
55
title: "QST:"
66
labels: "question"
77

88
---
99

10-
#### Question about pytask-xxxxx
10+
#### Question about pytask
1111

1212
**Note**: If you'd still like to submit a question, please read [this guide](
1313
https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to

‎.github/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Provide a description and/or bullet points to describe the changes in this PR.
66

77
- [ ] Reference issues which can be closed due to this PR with "Closes #x".
88
- [ ] Review whether the documentation needs to be updated.
9-
- [ ] Document PR in docs/changes.rst.
9+
- [ ] Document PR in CHANGES.rst.

‎.github/workflows/main.yml

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: main
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- '*'
10+
11+
jobs:
12+
13+
run-tests:
14+
15+
name: Run tests for ${{ matrix.os }} on ${{ matrix.python-version }}
16+
runs-on: ${{ matrix.os }}
17+
env:
18+
CONDA_EXE: mamba
19+
20+
strategy:
21+
fail-fast: false
22+
matrix:
23+
os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
24+
python-version: ['3.7', '3.8', '3.9']
25+
26+
steps:
27+
- uses: actions/checkout@v2
28+
- uses: conda-incubator/setup-miniconda@v2
29+
with:
30+
auto-update-conda: true
31+
python-version: ${{ matrix.python-version }}
32+
33+
- name: Install core dependencies.
34+
shell: bash -l {0}
35+
run: conda install -c conda-forge tox-conda coverage
36+
37+
- name: Run end-to-end tests.
38+
shell: bash -l {0}
39+
run: tox -e pytest -- tests -m end_to_end --cov=./ --cov-report=xml -n auto
40+
41+
- name: Upload coverage reports of end-to-end tests.
42+
if: runner.os == 'Linux' && matrix.python-version == '3.8'
43+
shell: bash -l {0}
44+
run: bash <(curl -s https://codecov.io/bash) -F end_to_end -c
45+
46+
47+
docs:
48+
49+
name: Run documentation.
50+
runs-on: ubuntu-latest
51+
52+
steps:
53+
- uses: actions/checkout@v2
54+
- uses: conda-incubator/setup-miniconda@v2
55+
with:
56+
auto-update-conda: true
57+
58+
- name: Install core dependencies.
59+
shell: bash -l {0}
60+
run: conda install -c conda-forge tox-conda
61+
62+
- name: Build docs
63+
shell: bash -l {0}
64+
run: tox -e sphinx

‎.gitignore

+134-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,133 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
/site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/
130+
1131
# Files
2132
.coverage
3133
coverage.*
@@ -9,11 +139,14 @@ coverage.*
9139
.vscode
10140
_build
11141
__pycache__
142+
_generated
12143

13144
*.egg-info
145+
.eggs
14146

15147
.pytask.sqlite3
16148

17149
build
18150
dist
19-
src/pytask_xxxxx/_version.py
151+
152+
version.py

0 commit comments

Comments
 (0)