tethysdash 0.18.0__tar.gz

tethysdash-0.18.0/.coveragerc

@@ -0,0 +1,10 @@
+[run] 
+omit =
+   *app.py,
+   */.tethys/*,
+   */tests/*,
+   */alembic/*
+source = tethysapp/tethysdash
+
+[report]
+skip_covered = True

tethysdash-0.18.0/.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+exclude = ./node_modules/

tethysdash-0.18.0/.gitignore

@@ -0,0 +1,27 @@
+*.pydevproject
+*.project
+*.egg-info
+*.class
+*.pyo
+*.pyc
+*.db
+*.sqlite
+*.DS_Store
+*__pycache__
+.idea/
+services.yml
+node_modules*
+tethysapp/tethysdash/workspaces/
+reactapp/config/production.env
+test.py
+.coverage
+launch.json
+cache
+coverage
+data
+build
+dist
+
+
+tethysapp/tethysdash/public/images/plugins/*
+tethysapp/tethysdash/public/data/plugins/*

tethysdash-0.18.0/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "editor.rulers": [88],
+  "terminal.integrated.cwd": "",
+  "terminal.integrated.splitCwd": "workspaceRoot"
+}

tethysdash-0.18.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Aquaveo
+
+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.

tethysdash-0.18.0/PKG-INFO

@@ -0,0 +1,214 @@
+Metadata-Version: 2.4
+Name: tethysdash
+Version: 0.18.0
+Summary: A Tethys App for no code/low code web application development app
+Author-email: Corey Krewson <ckrewson@aquaveo.com>
+Project-URL: homepage, https://tethysdashdocs.readthedocs.io/en/latest/
+Project-URL: documentation, https://tethysdashdocs.readthedocs.io/en/latest/
+Project-URL: repository, https://github.com/tethysplatform/tethysapp-tethys_dash
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: hjson==3.1
+Requires-Dist: nh3==0.2.21
+Requires-Dist: beautifulsoup4==4.13.4
+Requires-Dist: better_profanity==0.7.0
+Requires-Dist: bleach==6.1.0
+Requires-Dist: bleach[css]
+Requires-Dist: channels_redis==4.3.0
+Requires-Dist: django-redis==6.0.0
+Requires-Dist: cssutils==2.11.1
+Requires-Dist: pytest-django
+Requires-Dist: pytest-mock
+Requires-Dist: pytest-cov
+Requires-Dist: pytest-asyncio
+Requires-Dist: intake==2.0.7
+Requires-Dist: djangorestframework
+Requires-Dist: alembic==1.14.0
+Requires-Dist: xmltodict==0.14.2
+Requires-Dist: psycopg2-binary==2.9.11
+Requires-Dist: geoalchemy2==0.18.4
+Requires-Dist: tethys-platform>=4.5.0
+Dynamic: license-file
+
+# 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](https://tethysdashdocs.readthedocs.io/en/latest/index.html)
+
+## Quick Installation
+
+1. If creating a new python environment, create and activate it
+
+```
+    python3 -m venv test_env
+    source test_env/bin/activate
+```
+
+2. Install TethysDash
+
+```
+    pip install tethysdash
+```
+
+3. Setup Tethys and TethysDash Databases and Services
+
+```
+    tethysdash setup
+```
+
+4. Start Tethys Portal
+
+```
+    tethysdash start
+```
+
+## Development Installation
+
+You need to install both the Tethys dependencies and the node dependencies:
+
+1. Open Terminal and activate tethys env
+
+```
+conda activate tethys
+```
+
+2. Clone the Repo
+
+```
+git clone https://github.com/tethysplatform/tethysapp-tethys_dash
+```
+
+3. Install the app in Tethys Platform
+
+```
+cd tethysapp-tethys_dash/
+tethys install -d
+```
+
+4. Create Persistence Store (if not done already) (update connection string as needed)
+
+```
+## Command Line Interface (CLI)
+
+After installing tethysdash, you can use the CLI tool:
+
+```
+
+tethysdash
+
+```
+
+This will run the CLI entry point defined in the package. You can add arguments as needed:
+
+```
+
+tethysdash <arguments>
+
+```
+
+For example:
+
+```
+
+tethysdash --help
+
+```
+
+### Setup Command
+
+To run Tethys portal and database setup commands, use:
+
+```
+
+tethysdash setup
+
+```
+
+This will execute:
+
+- `tethys gen portal_config`
+- `tethys db configure`
+
+You must have the `tethys` CLI available in your environment.
+tethys services create persistent -n primary_db -c postgres:mysecretpassword@localhost:5432
+```
+
+5. Connect Persistence Store to TethysDash
+
+```
+tethys link persistent:primary_db tethysdash:ps_database:primary_db
+```
+
+6. Setup Environment Variables (not necessary unless connection values are different)
+
+```
+export POSTGRES_PASSWORD=mysecretpassword
+export TETHYS_DB_HOST=localhost
+export TETHYSDASH_DB_NAME=tethysdash_primary_db
+export TETHYS_DB_PORT=5432
+```
+
+7. Setup TethysDash DB Tables
+
+```
+tethys syncstores tethysdash
+```
+
+8. Install Plugin Examples (not necessary but recommended)
+
+```
+cd ..
+git clone https://github.com/FIRO-Tethys/tethysdash_examples
+cd tethysdash_examples
+pip install -e .
+```
+
+## 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-tethysdash
+npm install --dev
+```
+
+2. Start Tethys development server
+
+```
+tethys manage start
+```
+
+3. 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
+```
+
+## 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](https://eslint.org/) and a number of plugins for React. The testing capabilities include [jest](https://jestjs.io/), [jsdom](https://github.com/jsdom/jsdom#readme), [testing-framework](https://testing-library.com/), [user-event](https://testing-library.com/docs/user-event/intro/), and a few other JavaScript testing utilties to make it easy to test the frontend of the React-Tethys app.

tethysdash-0.18.0/README.md

@@ -0,0 +1,173 @@
+# 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](https://tethysdashdocs.readthedocs.io/en/latest/index.html)
+
+## Quick Installation
+
+1. If creating a new python environment, create and activate it
+
+```
+    python3 -m venv test_env
+    source test_env/bin/activate
+```
+
+2. Install TethysDash
+
+```
+    pip install tethysdash
+```
+
+3. Setup Tethys and TethysDash Databases and Services
+
+```
+    tethysdash setup
+```
+
+4. Start Tethys Portal
+
+```
+    tethysdash start
+```
+
+## Development Installation
+
+You need to install both the Tethys dependencies and the node dependencies:
+
+1. Open Terminal and activate tethys env
+
+```
+conda activate tethys
+```
+
+2. Clone the Repo
+
+```
+git clone https://github.com/tethysplatform/tethysapp-tethys_dash
+```
+
+3. Install the app in Tethys Platform
+
+```
+cd tethysapp-tethys_dash/
+tethys install -d
+```
+
+4. Create Persistence Store (if not done already) (update connection string as needed)
+
+```
+## Command Line Interface (CLI)
+
+After installing tethysdash, you can use the CLI tool:
+
+```
+
+tethysdash
+
+```
+
+This will run the CLI entry point defined in the package. You can add arguments as needed:
+
+```
+
+tethysdash <arguments>
+
+```
+
+For example:
+
+```
+
+tethysdash --help
+
+```
+
+### Setup Command
+
+To run Tethys portal and database setup commands, use:
+
+```
+
+tethysdash setup
+
+```
+
+This will execute:
+
+- `tethys gen portal_config`
+- `tethys db configure`
+
+You must have the `tethys` CLI available in your environment.
+tethys services create persistent -n primary_db -c postgres:mysecretpassword@localhost:5432
+```
+
+5. Connect Persistence Store to TethysDash
+
+```
+tethys link persistent:primary_db tethysdash:ps_database:primary_db
+```
+
+6. Setup Environment Variables (not necessary unless connection values are different)
+
+```
+export POSTGRES_PASSWORD=mysecretpassword
+export TETHYS_DB_HOST=localhost
+export TETHYSDASH_DB_NAME=tethysdash_primary_db
+export TETHYS_DB_PORT=5432
+```
+
+7. Setup TethysDash DB Tables
+
+```
+tethys syncstores tethysdash
+```
+
+8. Install Plugin Examples (not necessary but recommended)
+
+```
+cd ..
+git clone https://github.com/FIRO-Tethys/tethysdash_examples
+cd tethysdash_examples
+pip install -e .
+```
+
+## 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-tethysdash
+npm install --dev
+```
+
+2. Start Tethys development server
+
+```
+tethys manage start
+```
+
+3. 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
+```
+
+## 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](https://eslint.org/) and a number of plugins for React. The testing capabilities include [jest](https://jestjs.io/), [jsdom](https://github.com/jsdom/jsdom#readme), [testing-framework](https://testing-library.com/), [user-event](https://testing-library.com/docs/user-event/intro/), and a few other JavaScript testing utilties to make it easy to test the frontend of the React-Tethys app.

tethysdash-0.18.0/install.yml

@@ -0,0 +1,20 @@
+# This file should be committed to your app code.
+version: 1.1
+# This should be greater or equal to your tethys-platform in your environment
+tethys_version: ">=4.0.0"
+# This should match the app - package name in your setup.py
+name: tethysdash
+
+requirements:
+  # Putting in a skip true param will skip the entire section. Ignoring the option will assume it be set to False
+  skip: false
+  conda:
+    channels:
+      - conda-forge
+    packages:
+      - nodejs
+      - pandas
+
+  pip:
+
+post:

tethysdash-0.18.0/jsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "baseUrl": "reactapp",
+    "module": "CommonJS",
+    "target": "ES6"
+  },
+  "include": ["reactapp"],
+  "exclude": ["node_modules", "tethysapp"]
+}