Skip to main content

Main Python package to access the 3DTrees backend from tool containers

Project description

tool-interface

Main Python package to access the 3DTrees backend from tool containers. This package provides a unified interface for interacting with various backend services (Supabase, S3) used in the 3DTrees project.

Installation

Using uv:

uv pip install git+https://github.com/3dtrees-earth/tool-interface.git

Using pip:

pip install git+https://github.com/3dtrees-earth/tool-interface.git

Configuration

The package uses environment variables for configuration. All variables should be prefixed with THREEDTREES_. You can also use a .env file.

Required environment variables:

# Supabase
THREEDTREES_SUPABASE_URL=your_supabase_url
THREEDTREES_SUPABASE_KEY=your_supabase_key

# Storage (S3 compatible)
THREEDTREES_STORAGE_ACCESS_KEY=your_access_key
THREEDTREES_STORAGE_SECRET_KEY=your_secret_key
THREEDTREES_STORAGE_BUCKET_NAME=your_bucket_name

# Optional
THREEDTREES_STORAGE_ENDPOINT_URL=custom_s3_endpoint  # For non-AWS S3
THREEDTREES_STORAGE_REGION=eu-central-1  # Default: eu-central-1
THREEDTREES_PROCESSING_TEMP_DIR=/tmp/3dtrees  # Default: /tmp/3dtrees

Development

To set up the development environment:

  1. Clone the repository
  2. Install development dependencies:
    uv pip install -e ".[dev]"
    
  3. Install pre-commit hooks:
    pre-commit install
    

License

See LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tool_interface-0.1.0.tar.gz (31.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tool_interface-0.1.0-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

Details for the file tool_interface-0.1.0.tar.gz.

File metadata

  • Download URL: tool_interface-0.1.0.tar.gz
  • Upload date:
  • Size: 31.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tool_interface-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8b5ee3440e66e35407e48e22cbb25d1ad4f3a63f06de3bf402003f42317945ca
MD5 abac6cd543dd5a8de3fdcc963c88a283
BLAKE2b-256 ff3fd72b6e83d23fe9059a49920ace9090ed0aa022b479cdbf54ec0de8d62c2d

See more details on using hashes here.

Provenance

The following attestation bundles were made for tool_interface-0.1.0.tar.gz:

Publisher: publish.yml on 3dTrees-earth/tool-interface

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tool_interface-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tool_interface-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 29.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tool_interface-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff0850063cee69942c954ff32e7f32bb3f947a6ec7d52082b3c91e8399e97f31
MD5 2c2953677d0b637fe38526e639782216
BLAKE2b-256 e3e4595673c9a8934314f6cb002c22d1018953251c5d0df1d3f8978f06e7eca4

See more details on using hashes here.

Provenance

The following attestation bundles were made for tool_interface-0.1.0-py3-none-any.whl:

Publisher: publish.yml on 3dTrees-earth/tool-interface

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page