Skip to content

Commit fbc6bb5

Browse files
hmgaudeckerhmgaudecker
committed
Initial commit based on cookiecutter template.
0 parents  commit fbc6bb5

32 files changed

+1553
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
3+
name: Bug Report
4+
about: Create a bug report to help us improve pytask-xxxxx
5+
title: "BUG:"
6+
labels: "bug"
7+
8+
---
9+
10+
- [ ] I have checked that this issue has not already been reported.
11+
12+
- [ ] I have confirmed this bug exists on the latest version of pytask-xxxxx.
13+
14+
- [ ] (optional) I have confirmed this bug exists on the `main` branch of
15+
pytask-xxxxx.
16+
17+
---
18+
19+
**Note**: Please read [this
20+
guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing
21+
how to provide the necessary information for us to reproduce your bug.
22+
23+
#### Code Sample, a copy-pastable example
24+
25+
```python
26+
# Your code here
27+
```
28+
29+
#### Problem description
30+
31+
Explain **why** the current behaviour is a problem and why the expected output is a
32+
better solution.
33+
34+
#### Expected Output

‎.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
3+
name: Documentation Improvement
4+
about: Report wrong or missing documentation
5+
title: "DOC:"
6+
labels: "documentation"
7+
8+
---
9+
10+
#### Location of the documentation
11+
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).
16+
17+
#### Documentation problem
18+
19+
Provide a description of what documentation you believe needs to be fixed/improved.
20+
21+
#### Suggested fix for documentation
22+
23+
Explain the suggested fix and **why** it's better than the existing documentation.

‎.github/ISSUE_TEMPLATE/enhancement.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
3+
name: Enhancement
4+
about: Suggest an idea for pytask-xxxxx
5+
title: "ENH:"
6+
labels: "enhancement"
7+
8+
---
9+
10+
#### Is your feature request related to a problem?
11+
12+
Provide a description of what the problem is, e.g. "I wish I could use pytask-xxxxx
13+
to do [...]".
14+
15+
#### Describe the solution you'd like
16+
17+
Provide a description of the feature request and how it might be implemented.
18+
19+
#### API breaking implications
20+
21+
Provide a description of how this feature will affect the API.
22+
23+
#### Describe alternatives you've considered
24+
25+
Provide a description of any alternative solutions or features you've considered.
26+
27+
#### Additional context
28+
29+
Add any other context, code examples, or references to existing implementations about
30+
the feature request here.
31+
32+
```python
33+
# Your code here, if applicable
34+
```

‎.github/ISSUE_TEMPLATE/question.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
3+
name: Submit Question
4+
about: Ask a general question about pytask-xxxxx
5+
title: "QST:"
6+
labels: "question"
7+
8+
---
9+
10+
#### Question about pytask-xxxxx
11+
12+
**Note**: If you'd still like to submit a question, please read [this guide](
13+
https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to
14+
provide the necessary information for us to reproduce your question.
15+
16+
```python
17+
# Your code here, if applicable
18+
```

‎.github/pull_request_template.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#### Changes
2+
3+
Provide a description and/or bullet points to describe the changes in this PR.
4+
5+
#### Todo
6+
7+
- [ ] Reference issues which can be closed due to this PR with "Closes #x".
8+
- [ ] Review whether the documentation needs to be updated.
9+
- [ ] Document PR in docs/changes.rst.

‎.github/workflows/main.yml

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

‎.github/workflows/publish-to-pypi.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: PyPI
2+
3+
on: push
4+
5+
jobs:
6+
build-n-publish:
7+
name: Build and publish Python 🐍 distributions 📦 to PyPI
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@master
11+
12+
- name: Set up Python 3.8
13+
uses: actions/setup-python@v1
14+
with:
15+
python-version: 3.8
16+
17+
- name: Install pypa/build
18+
run: >-
19+
python -m
20+
pip install
21+
build
22+
--user
23+
24+
- name: Build a binary wheel and a source tarball
25+
run: >-
26+
python -m
27+
build
28+
--sdist
29+
--wheel
30+
--outdir dist/
31+
32+
- name: Publish distribution 📦 to PyPI
33+
if: startsWith(github.ref, 'refs/tags')
34+
uses: pypa/gh-action-pypi-publish@master
35+
with:
36+
password: ${{ secrets.PYPI_API_TOKEN }}

‎.gitignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Files
2+
.coverage
3+
coverage.*
4+
5+
# Folders
6+
.idea
7+
.ipynb_checkpoints
8+
.tox
9+
.vscode
10+
_build
11+
__pycache__
12+
13+
*.egg-info
14+
15+
.pytask.sqlite3
16+
17+
build
18+
dist
19+
src/pytask_julia/_version.py

‎.pre-commit-config.yaml

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.0.1
4+
hooks:
5+
- id: check-added-large-files
6+
args: ['--maxkb=100']
7+
- id: check-case-conflict
8+
- id: check-merge-conflict
9+
- id: check-vcs-permalinks
10+
- id: check-yaml
11+
exclude: meta.yaml
12+
- id: debug-statements
13+
- id: end-of-file-fixer
14+
- id: fix-byte-order-marker
15+
- id: forbid-new-submodules
16+
- id: mixed-line-ending
17+
- id: no-commit-to-branch
18+
args: [--branch, main]
19+
- id: trailing-whitespace
20+
- repo: https://github.com/pre-commit/pygrep-hooks
21+
rev: v1.9.0
22+
hooks:
23+
- id: python-check-blanket-noqa
24+
- id: python-check-mock-methods
25+
- id: python-no-eval
26+
- id: python-no-log-warn
27+
- id: python-use-type-annotations
28+
- id: rst-backticks
29+
- id: rst-directive-colons
30+
- id: rst-inline-touching-normal
31+
- id: text-unicode-replacement-char
32+
- repo: https://github.com/asottile/pyupgrade
33+
rev: v2.21.2
34+
hooks:
35+
- id: pyupgrade
36+
args: [--py36-plus]
37+
- repo: https://github.com/asottile/reorder_python_imports
38+
rev: v2.5.0
39+
hooks:
40+
- id: reorder-python-imports
41+
- repo: https://github.com/asottile/setup-cfg-fmt
42+
rev: v1.17.0
43+
hooks:
44+
- id: setup-cfg-fmt
45+
- repo: https://github.com/psf/black
46+
rev: 21.7b0
47+
hooks:
48+
- id: black
49+
- repo: https://github.com/asottile/blacken-docs
50+
rev: v1.10.0
51+
hooks:
52+
- id: blacken-docs
53+
additional_dependencies: [black]
54+
- repo: https://github.com/PyCQA/flake8
55+
rev: 3.9.2
56+
hooks:
57+
- id: flake8
58+
types: [python]
59+
additional_dependencies: [
60+
flake8-alfred,
61+
flake8-bugbear,
62+
flake8-builtins,
63+
flake8-comprehensions,
64+
flake8-docstrings,
65+
flake8-eradicate,
66+
flake8-print,
67+
flake8-pytest-style,
68+
flake8-todo,
69+
flake8-typing-imports,
70+
flake8-unused-arguments,
71+
pep8-naming,
72+
pydocstyle,
73+
Pygments,
74+
]
75+
- repo: https://github.com/PyCQA/doc8
76+
rev: 0.9.0
77+
hooks:
78+
- id: doc8
79+
- repo: https://github.com/econchick/interrogate
80+
rev: 1.4.0
81+
hooks:
82+
- id: interrogate
83+
args: [-v, --fail-under=40, src, tests]
84+
- repo: https://github.com/codespell-project/codespell
85+
rev: v2.1.0
86+
hooks:
87+
- id: codespell
88+
args: [-L unparseable]
89+
- repo: https://github.com/mgedmin/check-manifest
90+
rev: "0.46"
91+
hooks:
92+
- id: check-manifest
93+
- repo: meta
94+
hooks:
95+
- id: check-hooks-apply
96+
- id: check-useless-excludes
97+
# - id: identity # Prints all files passed to pre-commits. Debugging.

‎CHANGES.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Changes
2+
=======
3+
4+
This is a record of all past pytask-julia releases and what went into
5+
them in reverse chronological order. Releases follow `semantic versioning
6+
<https://semver.org/>`_ and all releases are available on `PyPI
7+
<https://pypi.org/project/pytask-julia>`_ and `Anaconda.org
8+
<https://anaconda.org/conda-forge/pytask-julia>`_.
9+
10+
11+
0.0.1 - 202X-XX-XX
12+
------------------
13+
14+
- :gh:`01` fixes ...

‎LICENSE

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
MIT License
3+
4+
Copyright (c) 2022, Tobias Raabe et al.
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy of this
7+
software and associated documentation files (the "Software"), to deal in the Software
8+
without restriction, including without limitation the rights to use, copy, modify,
9+
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to the following
11+
conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all copies or
14+
substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
17+
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
18+
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
20+
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21+
OTHER DEALINGS IN THE SOFTWARE.
22+
23+
24+

‎MANIFEST.in

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
prune tests
2+
3+
exclude *.rst
4+
exclude *.yml
5+
exclude *.yaml
6+
exclude *.ini
7+
8+
include README.rst
9+
include LICENSE

0 commit comments

Comments
 (0)