Create python package

.cruft.json

@@ -0,0 +1,27 @@
+{
+  "template": "https://github.com/Midnighter/cookiecutter-python-package",
+  "commit": "e8988f2331b6b12f2a78358fcbd78c013b1443c5",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "full_name": "OpenTECR developers",
+      "email": "[email protected]",
+      "dev_platform": "GitHub",
+      "__dev_platform_url": "https://github.com",
+      "dev_platform_username": "rgiessman",
+      "project_name": "OpenTECR Schema",
+      "project_slug": "opentecr-schema",
+      "project_module": "opentecr",
+      "project_short_description": "contains the code for the schema of the openTECR database",
+      "license": "MIT",
+      "release_date": "2023-12-12",
+      "year": "2023",
+      "_extensions": [
+        "jinja2_time.TimeExtension",
+        "jinja2_strcase.StrcaseExtension"
+      ],
+      "_template": "https://github.com/Midnighter/cookiecutter-python-package"
+    }
+  },
+  "directory": null
+}

.editorconfig

@@ -10,7 +10,7 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 max_line_length = 88
 
-[*.{json,yml}]
+[*.{json,yml,yaml}]
 indent_size = 2
 
 [*.{md,rst}]

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,130 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
+

.github/CONTRIBUTING.md

@@ -0,0 +1,134 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+## Example Contributions
+
+You can contribute in many ways, for example:
+
+* [Report bugs](#report-bugs)
+* [Fix Bugs](#fix-bugs)
+* [Implement Features](#implement-features)
+* [Write Documentation](#write-documentation)
+* [Submit Feedback](#submit-feedback)
+
+### Report Bugs
+
+Report bugs at https://github.com/rgiessman/opentecr-schema/issues.
+
+**If you are reporting a bug, please follow the template guidelines. The more
+detailed your report, the easier and thus faster we can help you.**
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything labelled with `bug` and `help
+wanted` is open to whoever wants to implement it. When you decide to work on
+such an issue, please [assign yourself to
+it](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)
+and add a comment that you'll be working on that, too. If you see another issue
+without the `help wanted` label, just post a comment, the maintainers are
+usually happy for any support that they can get.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything labelled with
+`enhancement` and `help wanted` is open to whoever wants to implement it. As for
+[fixing bugs](#fix-bugs), please [assign yourself to the
+issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)
+and add a comment that you'll be working on that, too. If another enhancement
+catches your fancy, but it doesn't have the `help wanted` label, just post a
+comment, the maintainers are usually happy for any support that they can get.
+
+### Write Documentation
+
+OpenTECR Schema could always use more documentation, whether as
+part of the official documentation, in docstrings, or even on the web in blog
+posts, articles, and such. Just [open an issue](https://github.com/rgiessman/opentecr-schema/issues) to let us know what you will be working on
+so that we can provide you with guidance.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at https://github.com/rgiessman/opentecr-schema/issues. If your feedback fits the format of one of
+the issue templates, please use that. Remember that this is a volunteer-driven
+project and everybody has limited time.
+
+## Get Started!
+
+Ready to contribute? Here's how to set up OpenTECR Schema for
+local development.
+
+1. Fork the https://github.com/rgiessman/opentecr-schema
+   repository on GitHub.
+2. Clone your fork locally
+
+    ```shell
+    git clone [email protected]:your_name_here/opentecr-schema.git
+    ```
+
+3. Install your local copy into a Python virtual environment. You can [read this
+   guide to learn
+   more](https://realpython.com/python-virtual-environments-a-primer) about them
+   and how to create one. Alternatively, particularly if you are a Windows or
+   Mac user, you can also use [Anaconda](https://docs.anaconda.com/anaconda/).
+   Once you have created a virtual environment and activated it, this is how you
+   set up your fork for local development
+
+    ```shell
+    cd opentecr-schema
+    pip install -e '.[development]'
+    pre-commit install
+    ```
+
+    The commands above install the package with all of its normal and
+    development dependencies into your virtual environment. The package itself
+    is installed in editable mode (`-e`) such that any modifications that you
+    make are immediately reflected in the installed package. Furthermore, we use
+    pre-commit hooks to ensure consistent code formatting. They are installed
+    with the command above and will run when you try to `git commit` your
+    changes.
+
+4. Create a branch for local development using the `devel` branch as a starting
+   point. Use `fix` or `feat` as a prefix for your branch name.
+
+    ```shell
+    git checkout devel
+    git checkout -b fix-name-of-your-bugfix
+    ```
+
+    Now you can make your changes locally.
+
+5. When you're done making changes, apply the quality assurance tools and check
+   that your changes pass our test suite. This is all included with tox
+
+    ```shell
+    tox
+    ```
+
+    You can also run tox in parallel to speed this up.
+
+    ```shell
+    tox -p auto
+    ```
+
+6. Commit your changes and push your branch to GitHub. Please use [semantic
+   commit messages](https://www.conventionalcommits.org/).
+
+    ```shell
+    git add .
+    git commit -m "fix: summarize your changes"
+    git push origin fix-name-of-your-bugfix
+    ```
+
+7. Open the link displayed in the message when pushing your new branch in order
+   to submit a pull request.
+
+### Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put your
+   new functionality into a function with a docstring.
+3. Your pull request will automatically be checked by the full tox test suite.
+   It needs to pass all of them before it can be considered for merging.

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

@@ -0,0 +1,64 @@
+name: 🐞 Bug report
+description: Report a problem to help improve this project
+title: "[BUG] "
+labels: [bug, triage]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+      - label: I have searched the existing issues
+        required: true
+  - type: textarea
+    attributes:
+      label: Problem description
+      description: |
+        A concise description of what you're experiencing.
+
+        Please explain:
+
+          * **what** you tried to achieve,
+          * **how** you went about it (referring to the code sample), and
+          * **why** the current behaviour is a problem and what output you expected instead.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Code sample
+      description: >
+        Create a [minimal, complete, verifiable example](https://stackoverflow.com/help/mcve).
+        Please, paste your code between the ``` tickmarks below or link to a [gist](https://gist.github.com/).
+      value: |
+        Code run:
+
+        ```python
+        ```
+
+        Traceback:
+
+        ```text
+        ```
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Environment
+      description: >
+        Please paste the output of running `depinfo --markdown opentecr-schema`
+        in your environment between the `details` tags below.
+      value: |
+        <details>
+
+        </details>
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
+
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/02-question.yml

@@ -0,0 +1,26 @@
+name: Question
+description: Ask a question
+title: "[Question] "
+labels: [question]
+body:
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      description: >
+        To help keep this issue tracker clean and focused, please make sure that you have
+         tried *all* of the following resources before submitting your question.
+      options:
+        - label: I searched the [documentation](https://opentecr-schema.readthedocs.io).
+          required: true
+        - label: I looked through existing [discussion topics](https://github.com/rgiessman/opentecr-schema/discussions).
+          required: true
+        - label: I looked for [similar issues](https://github.com/rgiessman/opentecr-schema/issues).
+          required: true
+        - label: I looked up my question/problem in a search engine.
+          required: true
+  - type: textarea
+    attributes:
+      label: Question
+      description: Please ask your question
+    validations:
+      required: true