across-tools 0.1.dev42__tar.gz

across_tools-0.1.dev42/.git_archival.txt

@@ -0,0 +1,4 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$

across_tools-0.1.dev42/.gitattributes

@@ -0,0 +1,24 @@
+# For explanation of this file and uses see
+# https://git-scm.com/docs/gitattributes
+# https://developer.lsst.io/git/git-lfs.html#using-git-lfs-enabled-repositories
+# https://lincc-ppt.readthedocs.io/en/latest/practices/git-lfs.html
+#
+# Used by https://github.com/lsst/afwdata.git
+# *.boost filter=lfs diff=lfs merge=lfs -text
+# *.dat filter=lfs diff=lfs merge=lfs -text
+# *.fits filter=lfs diff=lfs merge=lfs -text
+# *.gz filter=lfs diff=lfs merge=lfs -text
+#
+# apache parquet files
+# *.parq	filter=lfs diff=lfs merge=lfs -text
+#
+# sqlite files
+# *.sqlite3	filter=lfs diff=lfs merge=lfs -text
+#
+# gzip files
+# *.gz	filter=lfs diff=lfs merge=lfs -text
+#
+# png image files
+# *.png	filter=lfs diff=lfs merge=lfs -text
+
+.git_archival.txt export-subst

across_tools-0.1.dev42/.github/ISSUE_TEMPLATE/bug.yaml

@@ -0,0 +1,37 @@
+name: Bug
+description: Issue a bug report
+type: "bug"
+projects: ["NASA-ACROSS/22"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for issuing a bug report! Please describe it in detail below.
+
+  - type: textarea
+    id: description
+    validations:
+      required: true
+    attributes:
+      label: "Description"
+      description: What is the bug? Include images if appropriate.
+
+  - type: textarea
+    id: steps_to_reproduce
+    validations:
+      required: true
+    attributes:
+      label: "Steps to Reproduce"
+      description: Describe the steps needed to take to reproduce the issue.
+      value: |
+        1. [Step 1]
+        2. [Step 2]
+
+  - type: textarea
+    id: expected_behavior
+    validations:
+      required: true
+    attributes:
+      label: "Expected Behavior"
+      description: What is expected behavior instead of the bug?

across_tools-0.1.dev42/.github/ISSUE_TEMPLATE/spike.yaml

@@ -0,0 +1,40 @@
+name: Spike
+description: Investigative piece of work that is expected to lead into a feature issue once requirements are understood more concretely.
+type: "spike"
+projects: ["NASA-ACROSS/22"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please use this template to describe a piece of investigative work.
+
+  - type: textarea
+    id: goal
+    validations:
+      required: true
+    attributes:
+      label: "Goal"
+      description: Include the goal of the spike and why it is relevant.
+
+  - type: textarea
+    id: description
+    validations:
+      required: true
+    attributes:
+      label: "Description"
+      description: Enter a summary description of what is being investigated.
+      placeholder: |
+        Some examples of spikes:
+
+        - New technology to be added and be a comparison between options to show usage/performance/etc
+        - A new feature that has many potential implementations that have unknown implications or considerations
+        - Investigating if it a particular idea is worth implementing by doing some preliminary code experiments to see it's complexity/usage/feasibility.
+
+        Add any additional information/considerations as a bulleted list.
+
+  - type: textarea
+    id: references
+    attributes:
+      label: "References"
+      description: Optional section used to put a reference to another related issue, PR comment, Slack conversation, etc.

across_tools-0.1.dev42/.github/ISSUE_TEMPLATE/ticket.yaml

@@ -0,0 +1,114 @@
+name: Ticket
+description: A ticket that relates to a tech spec requirement that will be refined during planning.
+projects: ["NASA-ACROSS/22"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please use this template to describe a piece of work that has gone through the requirement gathering process.
+
+  - type: textarea
+    id: description
+    validations:
+      required: true
+    attributes:
+      label: "Description"
+      description: |
+        Describe the piece of work to be accomplished, usually describes the purpose or goal and why it is important.
+      placeholder: |
+        The purpose of this ticket is to provide the ability for users of the system to register
+        themselves. This is a dependency to allow users to be able to log in and use the system.
+
+  - type: input
+    id: references
+    attributes:
+      label: "References"
+      description: Recommended section to provide links to feature design or tech spec
+
+  - type: textarea
+    id: stakeholders
+    attributes:
+      label: "Stakeholders"
+      description: Please reference the stakeholders for this ticket
+      placeholder: "@NASA-ACROSS/developers"
+
+  - type: textarea
+    id: interfaces
+    attributes:
+      label: "Interfaces"
+      description: Are there interfaces that need to be defined?
+      placeholder: |
+        ```py
+        class UserCreate:
+          first_name: str
+          last_name: str
+          email: EmailStr
+        ```
+
+  - type: textarea
+    id: database
+    attributes:
+      label: "Database"
+      description: |
+        Are there database schema changes or additions?
+      placeholder: |
+        ```txt
+        user
+        ------------------------
+        first_name: varchar(255)
+        last_name: varchar(255)
+        email: varchar(100)
+        ```
+
+  - type: textarea
+    id: functional_requirements
+    validations:
+      required: true
+    attributes:
+      label: "Functional Requirements (FR)"
+      description: |
+        What does the ticket need to do?
+        What are the steps to implement the requirements?
+
+        This should be as detailed as needed for anyone to be able to contribute.
+      placeholder: |
+        1. Create a new route `POST /user` in the `routes/user/router.py` file to create a new user.
+        2. Add the `UserCreate` schema to the `schemas.py` file.
+        3. The route should take the `UserCreate` schema as the `POST` body.
+        4. The initial type validation should be handled by the pydantic model/schema.
+        5. A new `create` method should be added to the `UserService`.
+          1. The `create` method should check to see if the user already exists by `email` by using the existing `exists` method on `UserService`
+          2. If a user exists a `DuplicateUserException` should be raised.
+          3. Otherwise, create the user in the db by converting the `UserCreate` schema into the `User` db model.
+          4. Return the newly created user.
+        6. Return a `200` HTTP status along with the newly created user.
+
+  - type: textarea
+    id: non_functional_requirements
+    attributes:
+      label: "Non-Functional Requirements (NFR)"
+      description: |
+        What constraints exist for this ticket? All constraints must be quantifiable.
+      placeholder: |
+        1. Creating a user does not take longer than 1 second.
+
+  - type: textarea
+    id: acceptance_criteria
+    attributes:
+      label: "Acceptance Criteria"
+      description: |
+        What needs to happen functionally for this work to pass review?
+        Usually a combination of FRs and NFRs as test cases written in plain text.
+        This should follow test description formats. "Should...when..."
+      placeholder: |
+        1. Should return a status code of `200` when a new user is created successfully.
+        2. Should return new user information when a user is created successfully.
+        3. Should raise a `422` exception when an email is not sent in the body.
+        4. Should raise a `422` exception when an email is not correctly formatted.
+        5. Should raise a `409` exception when a user already exists with the provided `email`.
+
+  - type: markdown
+    attributes:
+      value: |
+        Finally, make sure to add the type of the ticket as "Task" or "Feature" to help tracking of issues.

across_tools-0.1.dev42/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "monthly"

across_tools-0.1.dev42/.github/pull_request_template.md

@@ -0,0 +1,39 @@
+<!-- 
+# IMPORTANT: Please do not create a Pull Request without creating an issue first
+-->
+
+## Title
+
+The title of the PR should follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary), as all the commits within the PR will be squashed under the title.
+
+feat(location): add Foo to Bar
+
+### Description
+
+A one to two sentence summary of the PR for easy digestion, must be
+different and more descriptive than title. Combination of tile and
+description should summarize the issue + solution.
+
+Feel free to add any additional information as a bulleted list.
+
+### Related Issue(s)
+
+Remove this line and link your issue here with the `Resolves` keyword
+Resolves #1234
+
+### Reviewers
+
+List all reviewers here and briefly describe why they are invited for
+review.
+By default, the PR author should merge once the reviewers have had a
+chance to review.
+If you have a different preference or cannot merge after review for some
+other constraint, leave a note about it here.
+
+### Acceptance Criteria
+
+What needs to happen functionally for this work to pass review, copy paste from issue.
+
+### Testing
+
+Add how you tested this PR and add a sequence of steps, with images where appropriate, for testing this PR.

across_tools-0.1.dev42/.github/workflows/build-documentation.yml

@@ -0,0 +1,39 @@
+
+# This workflow will install Python dependencies, build the package and then build the documentation.
+
+name: Build documentation
+
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.10'
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        python -m pip install --upgrade pip
+        if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi
+        pip install .
+    - name: Install notebook requirements
+      run: |
+        sudo apt-get install pandoc
+    - name: Build docs
+      run: |
+        sphinx-build -T -E -b html -d docs/build/doctrees ./docs docs/build/html

across_tools-0.1.dev42/.github/workflows/pre-commit-ci.yml

@@ -0,0 +1,36 @@
+
+# This workflow runs pre-commit hooks on pushes and pull requests to main
+# to enforce coding style. To ensure correct configuration, please refer to:
+#  https://lincc-ppt.readthedocs.io/en/latest/practices/ci_precommit.html
+name: Run pre-commit hooks
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  pre-commit-ci:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0 
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.10'
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        python -m pip install --upgrade pip
+        pip install .[dev]
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - uses: pre-commit/action@v3.0.1
+      with:
+        extra_args: --all-files --verbose
+      env:
+        SKIP: "check-lincc-frameworks-template-version,no-commit-to-branch,check-added-large-files,validate-pyproject,sphinx-build,pytest-check"
+    - uses: pre-commit-ci/lite-action@v1.1.0
+      if: failure() && github.event_name == 'pull_request' && github.event.pull_request.draft == false

across_tools-0.1.dev42/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,38 @@
+
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://github.com/pypa/gh-action-pypi-publish#trusted-publishing
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.10'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@release/v1

across_tools-0.1.dev42/.github/workflows/smoke-test.yml

@@ -0,0 +1,75 @@
+# This workflow will run daily at 06:45.
+# It will install Python dependencies and run tests with a variety of Python versions.
+# See documentation for help debugging smoke test issues:
+#    https://lincc-ppt.readthedocs.io/en/latest/practices/ci_testing.html#version-culprit
+
+name: Unit test smoke test
+
+on:
+
+  # Runs this workflow automatically
+  schedule:
+    - cron: 45 6 * * *
+    
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        python -m pip install --upgrade pip
+        pip install -e .[dev]
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: List dependencies
+      run: |
+        pip list
+    - name: Run unit tests with pytest
+      run: |
+        python -m pytest
+    - name: Send status to author's email      
+      if: ${{ failure() }} && github.event_name != 'workflow_dispatch' }} # Only email if the workflow failed and was not manually started. Customize this as necessary.
+      uses: dawidd6/action-send-mail@v4
+      with:
+        # Required mail server address if not connection_url:
+        server_address: smtp.gmail.com
+        # Server port: (uses TLS by default if server_port is 465)
+        server_port: 465
+
+        # Mail server username:
+        username: ${{secrets.MAIL_USERNAME}}
+        # Mail server password:
+        password: ${{secrets.MAIL_PASSWORD}}
+        # Required recipients' addresses:
+        to: samuel.d.wyatt@nasa.gov
+
+        # Required mail subject:
+        subject: Smoke test ${{ job.status }} in ${{github.repository}}
+        # Required sender full name:
+        from: GitHub Actions Report
+        # Optional body:
+        html_body: |
+          <!DOCTYPE html>
+          <html>
+          <body>
+          <h3>Smoke test ${{ job.status }}</h3>
+          <p>The smoke test in <b>${{ github.repository }}</b> has completed with result: <b>${{ job.status }}</b></p>
+          <p><a href="${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}">
+          ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+          </a></p>
+          </body>
+          </html>
+          

across_tools-0.1.dev42/.github/workflows/testing-and-coverage.yml

@@ -0,0 +1,38 @@
+# This workflow will install Python dependencies, run tests and report code coverage with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Unit test and code coverage
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        python -m pip install --upgrade pip
+        pip install -e .[dev]
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Run unit tests with pytest
+      run: |
+        python -m pytest --cov=tools --cov-report=xml
+    - name: Upload coverage report to codecov
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}