plotly-cloud 0.1.0rc1__tar.gz

plotly_cloud-0.1.0rc1/.gitignore

@@ -0,0 +1,176 @@
+# 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
+#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/#use-with-ide
+.pdm.toml
+
+# 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
+.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/
+
+# Ruff cache
+.ruff_cache
+
+# Pyright cache
+pyrightconfig.json
+.pyright/
+
+.claude
+
+# Editor directories and files
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Cloud environment configuration (created at packaging time)
+cloud-env.toml

plotly_cloud-0.1.0rc1/LICENSE

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

plotly_cloud-0.1.0rc1/PKG-INFO

@@ -0,0 +1,320 @@
+Metadata-Version: 2.4
+Name: plotly-cloud
+Version: 0.1.0rc1
+Summary: CLI for interacting with Plotly Cloud to deploy Dash apps
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: dash>=2.0.0
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: nest-asyncio>=1.6.0
+Requires-Dist: rich-argparse>=1.7.1
+Requires-Dist: rich>=10.0.0
+Requires-Dist: tomli-w>=1.2.0
+Requires-Dist: tomli>=2.2.1
+Description-Content-Type: text/markdown
+
+# Plotly Cloud CLI
+
+A command-line interface for interacting with Plotly Cloud to publish and manage Dash applications.
+
+## Features
+
+- 🔐 **Authentication**: Login/logout with Plotly Cloud using OAuth
+- 🚀 **Local Development**: Run Dash applications locally with comprehensive dev tools
+- 📦 **Publish**: Publish Dash applications to Plotly Cloud with metadata management
+- ⚙️ **Environment Configuration**: Centralized cloud configuration with staging/production support
+
+## Installation
+
+### From Source
+
+```bash
+git clone <repository-url>
+cd plotly-cloud-cli
+pip install -e .
+```
+
+### Development Installation
+
+For development, we recommend using UV and the provided Justfile:
+
+```bash
+git clone <repository-url>
+cd plotly-cloud-cli
+
+# Install UV if you haven't already
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Install dependencies
+just install
+
+# Setup cloud environment configuration
+just setup-cloud-env "your-staging-client-id" "your-production-client-id"
+
+# Install CLI in development mode
+just install-cli
+```
+
+## Quick Start
+
+### 1. Login to Plotly Cloud
+
+```bash
+plotly login
+```
+
+This will open your browser for OAuth authentication.
+
+### 2. Run a Dash Application
+
+```bash
+plotly run app:app
+```
+
+This runs your Dash app from the `app` module, using the `app` variable.
+
+### 3. Publish to Plotly Cloud
+
+```bash
+# For new applications (first publish)
+plotly publish --name "My App" --description "My application description"
+
+# For existing applications (with default polling)
+plotly publish
+
+# Publish without polling status
+plotly publish --poll-status=false
+```
+
+### 4. Logout
+
+```bash
+plotly logout
+```
+
+## Environment Configuration
+
+The CLI uses a `cloud-env.toml` file for environment-specific configuration (OAuth client IDs, API URLs). This file is gitignored and should be created during development or at packaging time.
+
+## Usage
+
+### Authentication Commands
+
+#### Login
+```bash
+plotly login [--browser | --no-browser]
+```
+
+Options:
+- `--browser`: Open browser for authentication (default)
+- `--no-browser`: Don't open browser automatically
+
+#### Logout
+```bash
+plotly logout
+```
+
+#### Check Current User
+```bash
+plotly whoami
+```
+
+Show current user information if logged in with a valid token. If the token is invalid, it will automatically clear the credentials.
+
+### Running Applications
+
+#### Basic Usage
+```bash
+plotly run <module:variable>
+```
+
+Examples:
+```bash
+plotly run app:app          # Run app from app.py
+plotly run myapp:dashboard  # Run dashboard from myapp.py
+plotly run main             # Run from main.py (looks for first Dash app)
+```
+
+#### Advanced Options
+
+```bash
+plotly run app:app --host 0.0.0.0 --port 8080 --debug
+```
+
+**Server Options:**
+- `--host`: Host IP address (default: 127.0.0.1)
+- `--port, -p`: Port number (default: 8050)
+- `--proxy`: Proxy configuration
+- `--debug, -d`: Enable debug mode
+
+**Development Tools:**
+- `--dev-tools-ui`: Enable dev tools UI
+- `--dev-tools-props-check`: Enable component prop validation
+- `--dev-tools-serve-dev-bundles`: Enable serving dev bundles
+- `--dev-tools-hot-reload`: Enable hot reloading
+- `--dev-tools-hot-reload-interval`: Hot reload polling interval (default: 3.0s)
+- `--dev-tools-hot-reload-watch-interval`: File watch interval (default: 0.5s)
+- `--dev-tools-hot-reload-max-retry`: Max failed reload attempts (default: 8)
+- `--dev-tools-silence-routes-logging`: Silence Werkzeug route logging
+- `--dev-tools-disable-version-check`: Disable Dash version upgrade check
+- `--dev-tools-prune-errors`: Prune tracebacks to user code only
+
+### Publishing Commands
+
+#### Publish Application
+```bash
+plotly publish [OPTIONS]
+```
+
+Publish your Dash application to Plotly Cloud with automatic status polling.
+
+**Options:**
+- `--project-path`: Path to project directory (default: current directory)
+- `--config`: Path to configuration file (default: plotly-cloud.toml)
+- `--name`: Application name (required for first publish)
+- `--description`: Application description (optional)
+- `--output`: Output path for publish zip file (default: temporary file)
+- `--keep-zip`: Keep the publish zip file after upload
+- `--poll-status`: Poll publish status until completion (default: true)
+- `--poll-interval`: Polling interval in seconds (default: 1.0)
+- `--poll-timeout`: Polling timeout in seconds (default: 180 = 3 minutes)
+
+**Examples:**
+```bash
+# Publish with default settings (includes status polling)
+plotly publish
+
+# Publish new app with custom name and description
+plotly publish --name "My Dashboard" --description "Sales analytics dashboard"
+
+# Publish without status polling
+plotly publish --poll-status=false
+
+# Publish with custom polling settings
+plotly publish --poll-interval=2.0 --poll-timeout=300
+
+# Publish and keep the zip file
+plotly publish --output=my-app.zip --keep-zip
+```
+
+#### Check Application Status
+```bash
+plotly status [OPTIONS]
+```
+
+Get current status and details of your published application.
+
+**Options:**
+- `--project-path`: Path to project directory (default: current directory)
+- `--config`: Path to configuration file (default: plotly-cloud.toml)
+
+**Example:**
+```bash
+plotly status
+```
+
+## Requirements
+
+- Python 3.9+
+
+### Python Dependencies
+
+- `httpx>=0.24.0` - HTTP client for API requests
+- `dash>=2.0.0` - Dash framework
+- `rich>=10.0.0` - Rich terminal formatting
+
+### Development Dependencies
+
+- `pytest>=6.0` - Testing framework
+- `ruff>=0.1.0` - Code linting and formatting
+- `pyright>=1.1.0` - Type checking
+
+## Development
+
+### Setup
+
+We use [`uv`](https://docs.astral.sh/uv/) to manage dependencies and [Just](https://github.com/casey/just) is used for task automation. Install them and use our Justfile for common development tasks:
+
+1. Clone the repository
+2. Install uv: `curl -LsSf https://astral.sh/uv/install.sh | sh` or on windows: `powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"`
+3. Install Just: `cargo install just` or see [installation docs](https://github.com/casey/just#installation)
+4. Setup the development environment:
+   ```bash
+   # Install dependencies
+   just install
+   
+   # Setup cloud environment configuration
+   just setup-cloud-env "your-staging-client-id" "your-production-client-id"
+   
+   # Install CLI in development mode
+   just install-cli
+   ```
+
+### Development Commands
+
+Run `just` or `just --list` to see all available commands:
+
+```bash
+# Testing
+just test                    # Run all tests
+just test-cov               # Run tests with coverage
+just test-file tests/test_commands.py  # Run specific test file
+
+# Code Quality
+just lint                   # Run linting
+just lint-fix              # Run linting with auto-fix
+just format                 # Format code
+just quality                # Run all quality checks (lint + typecheck + test)
+
+# Cloud Configuration
+just setup-cloud-env <staging_id> [production_id]  # Setup cloud config
+just show-cloud-config      # Display current configuration
+
+# Publishing
+just publish [path]          # Publish to cloud (default: current directory)
+
+# Development
+just install-cli            # Install CLI in development mode
+just test-cli              # Test CLI after installation
+just run-example app:app    # Run example Dash app
+
+# Maintenance
+just clean                  # Clean build artifacts
+just build                  # Build package
+```
+
+### Alternative Setup (without Just)
+
+If you prefer not to use Just:
+
+1. Create a virtual environment:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+   ```
+2. Install in development mode:
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+### Project Structure
+
+```
+plotly-cloud-cli/
+├── plotly_cloud/
+│   ├── __init__.py          # Package initialization
+│   ├── cli.py               # Main CLI entry point
+│   └── _commands.py         # Command implementations
+├── pyproject.toml           # Project configuration
+├── uv.lock                  # Dependency lock file
+├── .gitignore              # Git ignore rules
+└── README.md               # This file
+```
+
+## License
+
+[License information to be added]
+
+## Support
+
+For issues and questions, please open an issue on the GitHub repository.