prescient-sdk 0.1.0__tar.gz

prescient_sdk-0.1.0/.github/workflows/ci.yaml

@@ -0,0 +1,49 @@
+name: ci
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    types: [opened, reopened]
+
+# This job installs dependencies, runs tests, and checks formatting
+jobs:
+  run-ci:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+
+    strategy:
+      matrix:
+        python-version:
+        - "3.9"
+        - "3.10"
+        - "3.11"
+        - "3.12"
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v2
+      with:
+        # Install a specific version of uv.
+        version: "0.4.10"
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+
+    - name: Set up Python ${{ matrix.python-version }}
+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Install the project
+      run: uv sync --all-extras --dev
+
+    - name: run tests
+      run: |
+        uv run pytest tests/
+
+    - name: check-format
+      run: |
+        uv run ruff check

prescient_sdk-0.1.0/.github/workflows/deploy-book.yaml

@@ -0,0 +1,53 @@
+name: deploy-book
+
+# Run this when a new release tag is pushed
+on:
+  push:
+    tags: ['*.*.*']
+
+# This job installs dependencies, builds the book, and pushes it to `gh-pages`
+jobs:
+  deploy-book:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v2
+      with:
+        version: "0.4.10"
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+
+    - name: "Set up Python"
+      uses: actions/setup-python@v5
+      with:
+        python-version-file: ".python-version"
+
+    - name: Install the project
+      run: uv sync --all-extras --dev
+
+    - name: cache executed notebooks
+      uses: actions/cache@v3
+      with:
+        path: _build/.jupyter_cache
+        key: jupyter-book-cache-${{ hashFiles('uv.lock') }}
+
+    # Build the book
+    - name: Build the book
+      run: |
+        uv run jupyter-book build docs/
+
+    # Upload the book's HTML as an artifact
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: "docs/_build/html"
+
+    # Deploy the book's HTML to GitHub Pages
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

prescient_sdk-0.1.0/.github/workflows/publish.yaml

@@ -0,0 +1,51 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on:
+  push:
+    tags: ['*.*.*']
+
+env:
+    TWINE_USERNAME: __token__
+    TWINE_PASSWORD: ${{ secrets.PY_PI_API_TOKEN }}
+
+
+jobs:
+  deploy-book:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v2
+      with:
+        version: "0.4.10"
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+
+    - name: "Set up Python"
+      uses: actions/setup-python@v5
+      with:
+        python-version-file: ".python-version"
+
+    - name: Install the project
+      run: uv sync --all-extras --dev
+
+    # run tests and check formatting
+    - name: run tests
+      run: |
+        uv run pytest tests/
+
+    - name: check-format
+      run: |
+        uv run ruff check
+
+    # build and publish
+    - name: build project
+      run: uv build
+
+    - name: Publish to PyPI
+      run: uvx twine upload dist/* --non-interactive
+

prescient_sdk-0.1.0/.gitignore

@@ -0,0 +1,169 @@
+# 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/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+config.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/
+
+# config file for the prescient-sdk
+config.yaml
+
+# vscode
+.vscode/

prescient_sdk-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

prescient_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 sparkgeo.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

prescient_sdk-0.1.0/Makefile

@@ -0,0 +1,11 @@
+format:
+	uv run ruff check
+
+run-tests:
+	uv run pytest
+
+update-binder-reqs:
+	uv export --no-hashes --format requirements-txt > .binder/requirements.txt
+
+build-docs:
+	jupyter-book build docs/

prescient_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.3
+Name: prescient-sdk
+Version: 0.1.0
+Summary: A Python SDK for integrating with Prescient services
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: boto3>=1.35.19
+Requires-Dist: msal>=1.31.0
+Requires-Dist: pydantic-settings>=2.5.2
+Description-Content-Type: text/markdown
+
+# prescient-sdk
+A Python SDK for integrating with Prescient services
+
+
+# Quickstart
+
+## Local Development
+
+The project is set up using [uv](https://docs.astral.sh/uv/) for package management. To develop locally:
+
+1. Install uv following [these](https://docs.astral.sh/uv/getting-started/installation/) intructions
+
+1. (Optional) Use uv to set up your local env. 
+
+    Note that this will happen automatically when you run tests or any python application using uv, so it is not necessary
+
+    ```
+    uv sync
+    ```
+
+1. Run the tests
+
+    ```
+    uv run pytest
+    ```
+
+    or 
+
+    ```
+    make run-tests
+    ```
+
+## Configuration
+
+Configuration methods are discussed in the Jupyter Notebook [configuration.ipynb](./docs/examples/configuration.ipynb)
+
+## Code Formatting/Linting
+
+Code format is set using the [Ruff](https://docs.astral.sh/ruff/) formatter. To run this formatter:
+
+```
+make format
+```
+
+## Adding or removing dependencies
+
+Add or remove dependencies using [UV](https://docs.astral.sh/uv/concepts/dependencies/).
+
+In the simplest case, you can add a new dependency like this:
+
+```
+uv add <some-dependency>
+```
+
+To add a dev dependency:
+
+```
+uv add <some-dependency> --dev
+```
+
+To remove a dependency:
+
+```
+uv remove <some-dependency>
+```
+
+For more complex features, see the [uv documentation](https://docs.astral.sh/uv/)
+
+## Build the documentation
+
+Public facing documentation is built using [jupyter-books](https://jupyterbook.org/en/stable/intro.html).
+
+The [docs](./docs) folder contains the layout for the public facing documentation.
+
+You can build the documentation locally, and access the built html pages in a local browser:
+
+1. Build the docs:
+
+    ```
+    make build-docs
+    ```
+
+1. Open the html in a browser:
+
+    After building the docs, the path to the index.html file will be logged, and should look something like `docs/_build/html/index.html`

prescient_sdk-0.1.0/README.md

@@ -0,0 +1,85 @@
+# prescient-sdk
+A Python SDK for integrating with Prescient services
+
+
+# Quickstart
+
+## Local Development
+
+The project is set up using [uv](https://docs.astral.sh/uv/) for package management. To develop locally:
+
+1. Install uv following [these](https://docs.astral.sh/uv/getting-started/installation/) intructions
+
+1. (Optional) Use uv to set up your local env. 
+
+    Note that this will happen automatically when you run tests or any python application using uv, so it is not necessary
+
+    ```
+    uv sync
+    ```
+
+1. Run the tests
+
+    ```
+    uv run pytest
+    ```
+
+    or 
+
+    ```
+    make run-tests
+    ```
+
+## Configuration
+
+Configuration methods are discussed in the Jupyter Notebook [configuration.ipynb](./docs/examples/configuration.ipynb)
+
+## Code Formatting/Linting
+
+Code format is set using the [Ruff](https://docs.astral.sh/ruff/) formatter. To run this formatter:
+
+```
+make format
+```
+
+## Adding or removing dependencies
+
+Add or remove dependencies using [UV](https://docs.astral.sh/uv/concepts/dependencies/).
+
+In the simplest case, you can add a new dependency like this:
+
+```
+uv add <some-dependency>
+```
+
+To add a dev dependency:
+
+```
+uv add <some-dependency> --dev
+```
+
+To remove a dependency:
+
+```
+uv remove <some-dependency>
+```
+
+For more complex features, see the [uv documentation](https://docs.astral.sh/uv/)
+
+## Build the documentation
+
+Public facing documentation is built using [jupyter-books](https://jupyterbook.org/en/stable/intro.html).
+
+The [docs](./docs) folder contains the layout for the public facing documentation.
+
+You can build the documentation locally, and access the built html pages in a local browser:
+
+1. Build the docs:
+
+    ```
+    make build-docs
+    ```
+
+1. Open the html in a browser:
+
+    After building the docs, the path to the index.html file will be logged, and should look something like `docs/_build/html/index.html`

prescient_sdk-0.1.0/docs/_config.yml

@@ -0,0 +1,43 @@
+# Book settings
+# Learn more at https://jupyterbook.org/customize/config.html
+
+title: Prescient SDK
+author: Sparkgeo Consulting Inc
+logo: PE-1.png
+only_build_toc_files: true
+
+# Force re-execution of notebooks on each build.
+# See https://jupyterbook.org/content/execute.html
+execute:
+  execute_notebooks: off
+
+# Define the name of the latex output file for PDF builds
+latex:
+  latex_documents:
+    targetname: prescient_sdk.tex
+
+# Launch button settings
+launch_buttons:
+  notebook_interface: jupyterlab
+  binderhub_url: ""
+
+# Information about where the book exists on the web
+repository:
+  url: https://github.com/sparkgeo/prescient-sdk  # Online location of your book
+  path_to_book: docs  # Optional path to your book, relative to the repository root
+  branch: main  # Which branch of the repository should be used when creating links (optional)
+
+# Add GitHub buttons to your book
+# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
+html:
+  use_issues_button: true
+  use_repository_button: true
+
+sphinx:
+  extra_extensions:
+  - 'sphinx.ext.autodoc'
+  - 'sphinx.ext.napoleon'
+  - 'sphinx.ext.viewcode'
+  config:
+    add_module_names: False
+    suppress_warnings: ["etoc.toctree"]

prescient_sdk-0.1.0/docs/_toc.yml

@@ -0,0 +1,17 @@
+# Table of contents
+# Learn more at https://jupyterbook.org/customize/toc.html
+
+format: jb-book
+root: index
+parts:
+- caption: Getting Started
+  chapters:
+  - file: installation
+  - file: examples/configuration
+- caption: Examples
+  chapters:
+  - title: STAC Search
+    file: examples/stac_search
+- caption: SDK Reference
+  chapters:
+  - file: client-sdk

prescient_sdk-0.1.0/docs/client-sdk.rst

@@ -0,0 +1,5 @@
+Client
+======
+
+.. automodule:: prescient_sdk.client
+    :members: