Skip to content

Commit a9923a8

Browse files
committed
Release v0.0.1.
0 parents  commit a9923a8

31 files changed

+1355
-0
lines changed

.conda/bld.bat

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
"%PYTHON%" setup.py install
2+
if errorlevel 1 exit 1

.conda/build.sh

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
$PYTHON setup.py install # Python command to install the script.

.conda/meta.yaml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{% set data = load_setup_py_data() %}
2+
3+
package:
4+
name: pytask-stata
5+
version: {{ data.get('version') }}
6+
7+
source:
8+
# git_url is nice in that it won't capture devenv stuff. However, it only captures
9+
# committed code, so pay attention.
10+
git_url: ../
11+
12+
build:
13+
noarch: python
14+
number: 0
15+
16+
requirements:
17+
host:
18+
- python
19+
- setuptools
20+
21+
run:
22+
- python >=3.6
23+
- pytask >=0.0.8
24+
25+
test:
26+
requires:
27+
- pytest
28+
source_files:
29+
- tox.ini
30+
- tests
31+
commands:
32+
- pytask --version
33+
- pytask --help
34+
- pytask markers
35+
- pytask clean
36+
37+
- pytest tests
38+
39+
about:
40+
home: https://github.com/pytask-dev/pytask-stata
41+
license: none
42+
summary: Execute do-files with Stata.
43+
dev_url: https://github.com/pytask-dev/pytask-stata/

.github/ISSUE_TEMPLATE/bug_report.md

+34
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-stata
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-stata.
13+
14+
- [ ] (optional) I have confirmed this bug exists on the `main` branch of
15+
pytask-stata.
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
+23
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-stata.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

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
3+
name: Enhancement
4+
about: Suggest an idea for pytask-stata
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-stata
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

+18
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-stata
5+
title: "QST:"
6+
labels: "question"
7+
8+
---
9+
10+
#### Question about pytask-stata
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

+9
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.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
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 }}
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.6', '3.7', '3.8']
22+
23+
steps:
24+
- uses: actions/checkout@v2
25+
- uses: goanpeca/setup-miniconda@v1
26+
with:
27+
auto-update-conda: true
28+
python-version: ${{ matrix.python-version }}
29+
30+
- name: Install core dependencies.
31+
shell: bash -l {0}
32+
run: conda install -c conda-forge tox-conda coverage
33+
34+
# Unit, integration, and end-to-end tests.
35+
36+
- name: Run unit tests and doctests.
37+
shell: bash -l {0}
38+
run: tox -e pytest -- -m "unit or (not integration and not end_to_end)" --cov=./ --cov-report=xml -n auto
39+
40+
- name: Upload coverage report for unit tests and doctests.
41+
if: runner.os == 'Linux' && matrix.python-version == '3.8'
42+
shell: bash -l {0}
43+
run: bash <(curl -s https://codecov.io/bash) -F unit -c
44+
45+
# - name: Run integration tests.
46+
# shell: bash -l {0}
47+
# run: tox -e pytest -- -m integration --cov=./ --cov-report=xml -n auto
48+
49+
# - name: Upload coverage reports of integration tests.
50+
# if: runner.os == 'Linux' && matrix.python-version == '3.8'
51+
# shell: bash -l {0}
52+
# run: bash <(curl -s https://codecov.io/bash) -F integration -c
53+
54+
- name: Run end-to-end tests.
55+
shell: bash -l {0}
56+
run: tox -e pytest -- -m end_to_end --cov=./ --cov-report=xml -n auto
57+
58+
- name: Upload coverage reports of end-to-end tests.
59+
if: runner.os == 'Linux' && matrix.python-version == '3.8'
60+
shell: bash -l {0}
61+
run: bash <(curl -s https://codecov.io/bash) -F end_to_end -c
62+
63+
- name: Validate codecov.yml
64+
if: runner.os == 'Linux' && matrix.python-version == '3.8'
65+
shell: bash -l {0}
66+
run: cat codecov.yml | curl --data-binary @- https://codecov.io/validate
67+
68+
69+
pre-commit:
70+
71+
name: Run pre-commit.
72+
runs-on: ubuntu-latest
73+
74+
steps:
75+
- uses: actions/checkout@v2
76+
77+
- name: Set up Python 3.8
78+
uses: actions/setup-python@v1
79+
with:
80+
python-version: 3.8
81+
82+
- name: Install dependencies
83+
run: pip install tox
84+
85+
- name: Run pre-commit
86+
run: tox -e pre-commit

.gitignore

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
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

.pre-commit-config.yaml

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v3.2.0
4+
hooks:
5+
- id: check-added-large-files
6+
args: ['--maxkb=100']
7+
- id: check-merge-conflict
8+
- id: check-yaml
9+
exclude: meta.yaml
10+
- id: debug-statements
11+
- id: end-of-file-fixer
12+
- repo: https://github.com/asottile/pyupgrade
13+
rev: v2.7.2
14+
hooks:
15+
- id: pyupgrade
16+
args: [--py36-plus]
17+
- repo: https://github.com/asottile/reorder_python_imports
18+
rev: v2.3.5
19+
hooks:
20+
- id: reorder-python-imports
21+
- repo: https://github.com/psf/black
22+
rev: 20.8b1
23+
hooks:
24+
- id: black
25+
- repo: https://github.com/asottile/blacken-docs
26+
rev: v1.8.0
27+
hooks:
28+
- id: blacken-docs
29+
additional_dependencies: [black]
30+
- repo: https://gitlab.com/pycqa/flake8
31+
rev: 3.8.4
32+
hooks:
33+
- id: flake8
34+
types: [python]
35+
additional_dependencies: [
36+
flake8-alfred,
37+
flake8-bugbear,
38+
flake8-builtins,
39+
flake8-comprehensions,
40+
flake8-docstrings,
41+
flake8-eradicate,
42+
flake8-print,
43+
flake8-pytest-style,
44+
flake8-todo,
45+
flake8-unused-arguments,
46+
pep8-naming,
47+
pydocstyle,
48+
Pygments,
49+
]
50+
- repo: https://github.com/PyCQA/doc8
51+
rev: 0.9.0a1
52+
hooks:
53+
- id: doc8
54+
- repo: https://github.com/econchick/interrogate
55+
rev: 1.3.1
56+
hooks:
57+
- id: interrogate
58+
args: [-v, --fail-under=40, src, tests]
59+
- repo: https://github.com/codespell-project/codespell
60+
rev: v1.17.1
61+
hooks:
62+
- id: codespell
63+
- repo: meta
64+
hooks:
65+
- id: check-hooks-apply
66+
- id: check-useless-excludes
67+
# - id: identity # Prints all files passed to pre-commits. Debugging.

CHANGES.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Changes
2+
=======
3+
4+
This is a record of all past pytask-stata releases and what went into them in reverse
5+
chronological order. Releases follow `semantic versioning <https://semver.org/>`_ and
6+
all releases are available on `Anaconda.org <https://anaconda.org/pytask/pytask-stata>`_.
7+
8+
9+
0.0.1 - 2020-xx-xx
10+
------------------
11+
12+
- Release v0.0.1.

0 commit comments

Comments
 (0)