Skip to content

Commit aa84339

Browse files
MidnighterMidnighter
committed
chore: initialize project template
0 parents  commit aa84339

27 files changed

+2084
-0
lines changed

‎.cruft.json

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"template": "https://github.com/Midnighter/cookiecutter-python-package",
3+
"commit": "1abeb4e5e3f8528f750a7b448904677591c86e41",
4+
"checkout": null,
5+
"context": {
6+
"cookiecutter": {
7+
"full_name": "openTECR Community",
8+
"email": "moritz.beber@igdore.org",
9+
"dev_platform": "GitHub",
10+
"__dev_platform_url": "https://github.com",
11+
"dev_platform_username": "opentecr",
12+
"project_name": "Data Orchestration",
13+
"project_slug": "data-orchestration",
14+
"project_module": "data_orchestration",
15+
"project_short_description": "Transform and enrich the raw, curated openTECR data to produce suitable output formats.",
16+
"license": "Apache-2.0",
17+
"release_date": "2024-07-11",
18+
"year": "2024",
19+
"_extensions": [
20+
"jinja2_time.TimeExtension",
21+
"jinja2_strcase.StrcaseExtension"
22+
],
23+
"_template": "https://github.com/Midnighter/cookiecutter-python-package"
24+
}
25+
},
26+
"directory": null
27+
}

‎.editorconfig

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Editor Configuration (http://editorconfig.org)
2+
root = true
3+
4+
[*]
5+
charset = utf-8
6+
indent_style = space
7+
indent_size = 4
8+
end_of_line = lf
9+
insert_final_newline = true
10+
trim_trailing_whitespace = true
11+
max_line_length = 88
12+
13+
[*.{json,yml,yaml}]
14+
indent_size = 2
15+
16+
[*.{md,rst}]
17+
trim_trailing_whitespace = false
18+
19+
[Makefile]
20+
indent_style = tab

‎.github/CODE_OF_CONDUCT.md

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, religion, or sexual identity
11+
and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the
27+
overall community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[INSERT CONTACT METHOD].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series
87+
of actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or
94+
permanent ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
121+
122+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
123+
enforcement ladder](https://github.com/mozilla/diversity).
124+
125+
[homepage]: https://www.contributor-covenant.org
126+
127+
For answers to common questions about this code of conduct, see the FAQ at
128+
https://www.contributor-covenant.org/faq. Translations are available at
129+
https://www.contributor-covenant.org/translations.
130+

‎.github/CONTRIBUTING.md

+134
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# Contributing
2+
3+
Contributions are welcome, and they are greatly appreciated! Every little bit
4+
helps, and credit will always be given.
5+
6+
## Example Contributions
7+
8+
You can contribute in many ways, for example:
9+
10+
* [Report bugs](#report-bugs)
11+
* [Fix Bugs](#fix-bugs)
12+
* [Implement Features](#implement-features)
13+
* [Write Documentation](#write-documentation)
14+
* [Submit Feedback](#submit-feedback)
15+
16+
### Report Bugs
17+
18+
Report bugs at https://github.com/opentecr/data-orchestration/issues.
19+
20+
**If you are reporting a bug, please follow the template guidelines. The more
21+
detailed your report, the easier and thus faster we can help you.**
22+
23+
### Fix Bugs
24+
25+
Look through the GitHub issues for bugs. Anything labelled with `bug` and `help
26+
wanted` is open to whoever wants to implement it. When you decide to work on
27+
such an issue, please [assign yourself to
28+
it](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)
29+
and add a comment that you'll be working on that, too. If you see another issue
30+
without the `help wanted` label, just post a comment, the maintainers are
31+
usually happy for any support that they can get.
32+
33+
### Implement Features
34+
35+
Look through the GitHub issues for features. Anything labelled with
36+
`enhancement` and `help wanted` is open to whoever wants to implement it. As for
37+
[fixing bugs](#fix-bugs), please [assign yourself to the
38+
issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)
39+
and add a comment that you'll be working on that, too. If another enhancement
40+
catches your fancy, but it doesn't have the `help wanted` label, just post a
41+
comment, the maintainers are usually happy for any support that they can get.
42+
43+
### Write Documentation
44+
45+
Data Orchestration could always use more documentation, whether as
46+
part of the official documentation, in docstrings, or even on the web in blog
47+
posts, articles, and such. Just [open an issue](https://github.com/opentecr/data-orchestration/issues) to let us know what you will be working on
48+
so that we can provide you with guidance.
49+
50+
### Submit Feedback
51+
52+
The best way to send feedback is to file an issue at https://github.com/opentecr/data-orchestration/issues. If your feedback fits the format of one of
53+
the issue templates, please use that. Remember that this is a volunteer-driven
54+
project and everybody has limited time.
55+
56+
## Get Started!
57+
58+
Ready to contribute? Here's how to set up Data Orchestration for
59+
local development.
60+
61+
1. Fork the https://github.com/opentecr/data-orchestration
62+
repository on GitHub.
63+
2. Clone your fork locally
64+
65+
```shell
66+
git clone git@github.com:your_name_here/data-orchestration.git
67+
```
68+
69+
3. Install your local copy into a Python virtual environment. You can [read this
70+
guide to learn
71+
more](https://realpython.com/python-virtual-environments-a-primer) about them
72+
and how to create one. Alternatively, particularly if you are a Windows or
73+
Mac user, you can also use [Anaconda](https://docs.anaconda.com/anaconda/).
74+
Once you have created a virtual environment and activated it, this is how you
75+
set up your fork for local development
76+
77+
```shell
78+
cd data-orchestration
79+
pip install -e '.[development]'
80+
pre-commit install
81+
```
82+
83+
The commands above install the package with all of its normal and
84+
development dependencies into your virtual environment. The package itself
85+
is installed in editable mode (`-e`) such that any modifications that you
86+
make are immediately reflected in the installed package. Furthermore, we use
87+
pre-commit hooks to ensure consistent code formatting. They are installed
88+
with the command above and will run when you try to `git commit` your
89+
changes.
90+
91+
4. Create a branch for local development using the `devel` branch as a starting
92+
point. Use `fix` or `feat` as a prefix for your branch name.
93+
94+
```shell
95+
git checkout devel
96+
git checkout -b fix-name-of-your-bugfix
97+
```
98+
99+
Now you can make your changes locally.
100+
101+
5. When you're done making changes, apply the quality assurance tools and check
102+
that your changes pass our test suite. This is all included with tox
103+
104+
```shell
105+
tox
106+
```
107+
108+
You can also run tox in parallel to speed this up.
109+
110+
```shell
111+
tox -p auto
112+
```
113+
114+
6. Commit your changes and push your branch to GitHub. Please use [semantic
115+
commit messages](https://www.conventionalcommits.org/).
116+
117+
```shell
118+
git add .
119+
git commit -m "fix: summarize your changes"
120+
git push origin fix-name-of-your-bugfix
121+
```
122+
123+
7. Open the link displayed in the message when pushing your new branch in order
124+
to submit a pull request.
125+
126+
### Pull Request Guidelines
127+
128+
Before you submit a pull request, check that it meets these guidelines:
129+
130+
1. The pull request should include tests.
131+
2. If the pull request adds functionality, the docs should be updated. Put your
132+
new functionality into a function with a docstring.
133+
3. Your pull request will automatically be checked by the full tox test suite.
134+
It needs to pass all of them before it can be considered for merging.

‎.github/ISSUE_TEMPLATE/01-bug-report.yml

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: 🐞 Bug report
2+
description: Report a problem to help improve this project
3+
title: "[BUG] "
4+
labels: [bug, triage]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the bug you encountered.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Problem description
16+
description: |
17+
A concise description of what you're experiencing.
18+
19+
Please explain:
20+
21+
* **what** you tried to achieve,
22+
* **how** you went about it (referring to the code sample), and
23+
* **why** the current behaviour is a problem and what output you expected instead.
24+
validations:
25+
required: false
26+
- type: textarea
27+
attributes:
28+
label: Code sample
29+
description: >
30+
Create a [minimal, complete, verifiable example](https://stackoverflow.com/help/mcve).
31+
Please, paste your code between the ``` tickmarks below or link to a [gist](https://gist.github.com/).
32+
value: |
33+
Code run:
34+
35+
```python
36+
```
37+
38+
Traceback:
39+
40+
```text
41+
```
42+
validations:
43+
required: false
44+
- type: textarea
45+
attributes:
46+
label: Environment
47+
description: >
48+
Please paste the output of running `depinfo --markdown data-orchestration`
49+
in your environment between the `details` tags below.
50+
value: |
51+
<details>
52+
53+
</details>
54+
validations:
55+
required: true
56+
- type: textarea
57+
attributes:
58+
label: Anything else?
59+
description: |
60+
Links? References? Anything that will give us more context about the issue you are encountering!
61+
62+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
63+
validations:
64+
required: false

0 commit comments

Comments
 (0)