Initial Scaffold

Author: zprobst

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+#This is used to automatically add reviewers to PR's. Developers can still manually add reviewers in addition to the below users.
+
+* @zprobst @ccloes

.github/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing
+
+Review our Contributing Guide [in the Docs](https://nodestream-proj.github.io/nodestream/contributing).

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: zprobst
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[REQUEST]"
+labels: enhancement
+assignees: zprobst
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/ci.yaml

@@ -0,0 +1,38 @@
+name: Continuous Integration
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Poetry
+        run: curl -sSL https://install.python-poetry.org | python -
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: poetry
+          cache-dependency-path: poetry.lock
+      - name: Install Dependenencies
+        run: |
+          poetry env use ${{ matrix.python-version }}
+          poetry install
+      - name: Run Tests
+        run: poetry run pytest --cov nodestream_plugin_semantic --cov-report term --cov-report xml
+      - name: Run Lints
+        run: |
+          poetry run ruff nodestream_plugin_semantic tests
+          poetry run black nodestream_plugin_semantic tests --check
+          poetry run isort nodestream_plugin_semantic tests --check-only
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: ${{ matrix.python-version }}

.github/workflows/release.yaml

@@ -0,0 +1,76 @@
+name: Release
+
+# Trigger the workflow on a release event. 
+# This will trigger the workflow when a release is published - so draft releases will not trigger the workflow.
+on: 
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    # Name of the job for the workflow.
+    name: Publish Package to PyPI
+    runs-on: ubuntu-latest
+    
+    # Get the oidc token with write permissions to upload the package to PyPI.
+    # We have configured the trusted OIDC token in the pypi project settings.
+    # See here: https://docs.pypi.org/trusted-publishers/using-a-publisher/
+    permissions:
+      id-token: write
+      attestations: write
+  
+    # Use the Github Actions Environment to isolate the workflow from the rest of the repository. 
+    # See here: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment
+    environment:
+      name: pypi
+      url: https://pypi.org/p/nodestream-plugin-dotenv/
+    
+    steps:
+      # Checkout the repository subject to the release.
+      - uses: actions/checkout@v4
+
+      # Install poetry to build the package.
+      - name: Install poetry
+        run: pipx install poetry
+
+      # Set up Python 3.12 to build the package.
+      # Python version here does not really matter as long as it works with 
+      # poetry because its simply building the package. We've confirmed functionality
+      # with CI testing before this step.
+      - name: Set up Python 3.12 
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+          cache: 'poetry'
+      
+      # Build the package using poetry. This will create a dist directory with the package.
+      # Poetry isn't _special_ in the sense that it builds packages in some unique way.
+      # Therefore, we can use poetry built packaes with PyPA's action for publishing packages below.
+      # See: https://python-poetry.org/docs/cli/#build
+      - name: Build Package
+        run: poetry build
+      
+      # Publish the package to PyPI using the OIDC token and PyPA's action for publishing packages.
+      # By default, this action will publish to the PyPI server and pull artifacts from the dist directory.
+      # Dist directory is where poetry builds the package in the previous step.
+      # See:
+      # - https://github.com/marketplace/actions/pypi-publish
+      # - https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      # We are then going to store the built package as an artifact. 
+      # This is so we can sign the package and upload it to the GitHub release.
+      # this is being done as a seperate job so that we can minimize the permissions needed for the publish job.
+      - name: Store the Built Package
+        uses: actions/upload-artifact@v3
+        with:
+          name: python-package-distribution
+          path: dist/
+
+      # We are then going to sign the package using Github's Attest Build Provenance action.
+      # This action will sign the package and upload the signature to the GitHub release.
+      # This is to ensure that the package is verified and trusted by the user.
+      - uses: actions/attest-build-provenance@v1
+        with:
+          subject-path: 'dist/*'

.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/