Skip to main content

TethysDash

This app was created using an experimental Tethys + React app scaffold. It uses React for the frontend of the app and Tethys as the backend. For more detailed information, check the official TethysDash documentation

Quick Installation

  1. If creating a new python environment, create and activate it
    python3 -m venv test_env
    source test_env/bin/activate
  1. Install TethysDash
    pip install tethysdash
  1. Setup Tethys and TethysDash Databases and Services
    tethysdash setup
  1. Start Tethys Portal
    tethysdash start

Development Installation

You need to install both the Tethys dependencies and the node dependencies:

  1. If creating a new python environment, create and activate it
    python3 -m venv test_env
    source test_env/bin/activate
  1. Clone the Repo
git clone https://github.com/tethysplatform/tethysapp-tethys_dash
  1. Install the app in Tethys Platform
cd tethysapp-tethys_dash/
pip install -e .
  1. Setup Tethys and TethysDash Databases and Services
    tethysdash setup
  1. Install Plugin Examples (not necessary but recommended)
cd ..
git clone https://github.com/FIRO-Tethys/tethysdash_examples
cd tethysdash_examples
pip install -e .
  1. Start Tethys Portal
    tethysdash start

Frontend Development

The webpack dev server is configured to proxy the Tethys development server (see webpack.config.js). The app endpoint will be handled by the webpack development server and all other endpoints will be handled by the Tethys (Django) development server. As such, you will need to start both in separate terminals.

  1. Install the node and dependencies
cd tethysapp-tethys_dash/
npm install --dev
  1. Start Tethys development server
tethys manage start
  1. Start webpack development server (in separate terminal)
npm start

Frontend Build

Webpack is configured to bundle and build the React app into the tethysapp/<app_package>/public/frontend directory. Before building a Python distribution for release, you should build using this command:

npm run build

Note: The compiled frontend in tethysapp/tethysdash/public/frontend/ is not committed to the repository — CI builds it when publishing a release. When running the app from a clone, you must build it yourself first: either run npm run build before tethysdash start, or use the webpack dev server (npm start) which serves the bundle from memory. Without one of these, Django has no frontend bundle to serve.

Serving the built frontend in development

The production build emits content-hashed filenames (e.g. main.<hash>.js) and a manifest.json mapping logical names to the hashed files. Mode detection is automatic:

  • Hit Django directly (e.g. localhost:8000/apps/tethysdash/) → the page loads the hashed bundle named in manifest.json, served straight from the app's public/frontend/ directory.
  • Hit the webpack dev server (e.g. localhost:8080) → the dev server proxies the page request to Django with an X-Webpack-Dev-Server header. Django detects it and renders the unhashed main.js URL, which the dev server serves from memory.

No environment variable or DEBUG toggle is required to switch between the two.

Frontend Test

Use the following commands to lint and test the React portion of the app.

npm run lint
npm run test

The linting capability is powered by eslint and a number of plugins for React. The testing capabilities include jest, jsdom, testing-framework, user-event, and a few other JavaScript testing utilties to make it easy to test the frontend of the React-Tethys app.

Backend Lint and Test

The Python backend is linted with ruff and tested with pytest:

ruff check .
python -m pytest --reuse-db

Continuous Integration and Releasing

CI runs in GitHub Actions (.github/workflows/):

  • On every pull request to main (ci.yml): the frontend (eslint, prettier, jest) and backend (ruff, pytest) suites must pass.
  • On a version tag (release.yml): the suite re-runs, then the package is built and published to PyPI.

The package version is dynamic — it is derived from the git tag at build time by setuptools_scm, not stored in pyproject.toml. To cut a release, push a v-prefixed semantic-version tag from main:

git tag v0.19.17
git push origin v0.19.17

This triggers the release workflow, which publishes tethysdash 0.19.17 to PyPI (via PyPI Trusted Publishing) and creates a GitHub Release. Tags must use the v prefix for the workflow to fire.

Metadata

Release files for tethysdash 0.20.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tethysdash 0.20.2
File Size Uploaded Provenance Actions
tethysdash-0.20.2.tar.gz 9.6 MB With provenance Details for tethysdash-0.20.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tethysdash 0.20.2
File Interpreter ABI Platform Actions
tethysdash-0.20.2-py3-none-any.whl Python 3 none any Details for tethysdash-0.20.2-py3-none-any.whl

Total release size: 19.3 MB

Release files / tethysdash-0.20.2.tar.gz

Download URL tethysdash-0.20.2.tar.gz
Size 9.6 MB
Tags Source
SHA-256 checksum
How to use checksums
06f2721a4dffc04ef1f26b818f1735e4eae7576e2b1564392fadd4f7dc2a8138
BLAKE2b-256 checksum
How to use checksums
0caa111b8f3b6bd33723dffde3be93f26a992541970907886f8c8997a6518890
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

Release files / tethysdash-0.20.2-py3-none-any.whl

Download URL tethysdash-0.20.2-py3-none-any.whl
Size 9.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
0462efae4bc8e9db8770e01b962b0d2abe522224cc423ce305da964d346f45bb
BLAKE2b-256 checksum
How to use checksums
37091b8485fefd6ca104eab58227b1f3bafb9d85509172426e83be7af8350312
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

Security for tethysdash 0.20.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for tethysdash-0.20.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.20.2 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page