Skip to content

Commit c29dd81

Browse files
timmenstimmens
committed
Initial commit
0 parents  commit c29dd81

21 files changed

+699
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
3+
name: Bug Report
4+
about: Create a bug report to help us improve fte
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 fte.
13+
14+
- [ ] (optional) I have confirmed this bug exists on the `main` branch of fte.
15+
16+
---
17+
18+
**Note**: Please read [this
19+
guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing
20+
how to provide the necessary information for us to reproduce your bug.
21+
22+
#### Code Sample, a copy-pastable example
23+
24+
```python
25+
# Your code here
26+
```
27+
28+
#### Problem description
29+
30+
Explain **why** the current behaviour is a problem and why the expected output is a
31+
better solution.
32+
33+
#### 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://fte.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 fte
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
13+
fte 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 fte
5+
title: "QST:"
6+
labels: "question"
7+
8+
---
9+
10+
#### Question about pytask
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: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: main
2+
3+
# Automatically cancel a previous run.
4+
concurrency:
5+
group: ${{ github.head_ref || github.run_id }}
6+
cancel-in-progress: true
7+
8+
9+
on:
10+
push:
11+
branches:
12+
- main
13+
pull_request:
14+
branches:
15+
- '*'
16+
17+
jobs:
18+
19+
run-tests:
20+
21+
name: Run tests for ${{ matrix.os }} on ${{ matrix.python-version }}
22+
runs-on: ${{ matrix.os }}
23+
24+
strategy:
25+
fail-fast: false
26+
matrix:
27+
os: ['ubuntu-latest', 'macos-latest']
28+
python-version: ['3.7', '3.8', '3.9', '3.10']
29+
30+
steps:
31+
- uses: actions/checkout@v2
32+
- uses: conda-incubator/setup-miniconda@v2
33+
with:
34+
auto-update-conda: true
35+
python-version: ${{ matrix.python-version }}
36+
37+
- name: Install core dependencies.
38+
shell: bash -l {0}
39+
run: conda install -c conda-forge tox-conda coverage
40+
41+
# Unit, integration, and end-to-end tests.
42+
43+
- name: Run unit tests and doctests.
44+
shell: bash -l {0}
45+
run: tox -e pytest -- src tests -m "unit or (not integration and not end_to_end)" --cov=./ --cov-report=xml -n auto
46+
47+
- name: Upload coverage report for unit tests and doctests.
48+
if: runner.os == 'Linux' && matrix.python-version == '3.9'
49+
shell: bash -l {0}
50+
run: bash <(curl -s https://codecov.io/bash) -F unit -c
51+
52+
- name: Run end-to-end tests.
53+
if: runner.os != 'macOS' && matrix.python-version != '3.9'
54+
shell: bash -l {0}
55+
run: tox -e pytest -- src tests -m end_to_end --cov=./ --cov-report=xml -n auto
56+
57+
- name: Upload coverage reports of end-to-end tests.
58+
if: runner.os == 'Linux' && matrix.python-version == '3.9'
59+
shell: bash -l {0}
60+
run: bash <(curl -s https://codecov.io/bash) -F end_to_end -c

‎.gitignore

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

0 commit comments

Comments
 (0)