sleap-share 0.1.2__py3-none-any.whl

sleap_share-0.1.2.dist-info/METADATA

@@ -0,0 +1,204 @@
+Metadata-Version: 2.4
+Name: sleap-share
+Version: 0.1.2
+Summary: Python client for SLEAP Share - upload and share SLEAP datasets
+Project-URL: Homepage, https://slp.sh
+Project-URL: Documentation, https://github.com/talmolab/sleap-share
+Project-URL: Repository, https://github.com/talmolab/sleap-share
+Project-URL: Issues, https://github.com/talmolab/sleap-share/issues
+Author-email: Talmo Pereira <talmo@salk.edu>
+License-Expression: MIT
+Keywords: cli,data-sharing,pose-estimation,sleap
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.9.0
+Provides-Extra: all
+Requires-Dist: fsspec>=2024.0.0; extra == 'all'
+Requires-Dist: keyring>=25.0.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.30.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Provides-Extra: keyring
+Requires-Dist: keyring>=25.0.0; extra == 'keyring'
+Provides-Extra: lazy
+Requires-Dist: fsspec>=2024.0.0; extra == 'lazy'
+Description-Content-Type: text/markdown
+
+# sleap-share
+
+Python client for [SLEAP Share](https://slp.sh) - upload and share SLEAP datasets.
+
+## Installation
+
+```bash
+pip install sleap-share
+```
+
+Or use with `uvx` for one-off commands:
+
+```bash
+uvx sleap-share upload labels.slp
+```
+
+## Quick Start
+
+### Command Line
+
+```bash
+# Upload a file (no account needed)
+sleap-share upload labels.slp
+# → https://slp.sh/aBcDeF
+
+# Download a file
+sleap-share download aBcDeF
+
+# Get file info
+sleap-share info aBcDeF
+
+# Authenticate for more features
+sleap-share login
+
+# List your uploads
+sleap-share list
+
+# Delete a file
+sleap-share delete aBcDeF
+```
+
+### Python API
+
+```python
+import sleap_share
+
+# Upload (anonymous)
+result = sleap_share.upload("labels.slp")
+print(result.share_url)  # https://slp.sh/aBcDeF
+
+# Download
+sleap_share.download("aBcDeF", output="./data/")
+
+# Get metadata
+metadata = sleap_share.get_metadata("aBcDeF")
+print(f"Labeled frames: {metadata.labeled_frames_count}")
+
+# Lazy loading (stream data on-demand without full download)
+import sleap_io
+url = sleap_share.open("aBcDeF")
+labels = sleap_io.load_slp(url)  # Only fetches accessed data!
+```
+
+### Authenticated Operations
+
+```python
+# Use stored credentials from `sleap-share login`
+client = sleap_share.Client()
+
+# Or provide token directly
+client = sleap_share.Client(token="slpsh_live_...")
+
+# List your files
+files = client.list_files()
+
+# Delete a file
+client.delete("aBcDeF")
+
+# Get user info
+user = client.whoami()
+```
+
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `login` | Authenticate via browser |
+| `logout` | Clear stored credentials |
+| `whoami` | Show current user |
+| `upload <file>` | Upload a .slp file |
+| `download <id>` | Download a file |
+| `list` | List your uploads |
+| `info <id>` | Show file metadata |
+| `preview <id>` | Download preview image |
+| `delete <id>` | Delete a file |
+| `version` | Show version |
+
+### Global Options
+
+- `--env staging` - Target staging environment instead of production
+- `--help` - Show help for any command
+
+## Environment Variables
+
+- `SLEAP_SHARE_ENV` - Default environment (`production` or `staging`)
+
+## Token Storage
+
+Credentials are stored securely using:
+1. System keyring (macOS Keychain, Windows Credential Manager, Linux Secret Service)
+2. Fallback: `~/.config/sleap-share/credentials` with `0600` permissions
+
+## Development
+
+```bash
+cd client
+
+# Install dependencies
+uv sync --all-extras
+
+# Run tests
+uv run pytest
+
+# Lint and format
+uv run ruff check .
+uv run ruff format .
+
+# Type check
+uv run mypy src/sleap_share
+```
+
+## Releasing
+
+New versions are published to PyPI via GitHub Releases.
+
+### Steps to Release
+
+1. **Update version** in `pyproject.toml` and `src/sleap_share/__init__.py`
+
+2. **Update CHANGELOG.md** with the new version and release notes
+
+3. **Create a GitHub Release:**
+   - Go to [Releases](https://github.com/talmolab/sleap-share/releases/new)
+   - **Tag:** `client-v{version}` (e.g., `client-v0.2.0`)
+   - **Title:** `Python Client v{version}`
+   - **Description:** Copy from CHANGELOG.md
+   - Click **Publish release**
+
+4. The GitHub Action will automatically:
+   - Run tests on Python 3.9-3.13
+   - Run linting and type checks
+   - Build the package
+   - Publish to PyPI via OIDC trusted publishing
+
+### Version Scheme
+
+Tags must start with `client-v` to trigger publishing (e.g., `client-v0.1.0`, `client-v1.0.0`).
+
+This prefix distinguishes Python client releases from other releases in the monorepo.
+
+## License
+
+MIT License - see [LICENSE](../LICENSE) for details.

sleap_share-0.1.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+sleap_share/__init__.py,sha256=8cSqjeM_pvWuChEU8D2ft0fxzx58ZRGHYoX0Nq6Hj6U,7777
+sleap_share/auth.py,sha256=FMHQUehbH70lJkgW1AOpn9QaJ1PWQwjsEpZkvBiGZfM,9027
+sleap_share/cli.py,sha256=y2ksttPOMSWnTbdS8fmfUfXXVEGCroR6dVjMJrzULJY,14736
+sleap_share/client.py,sha256=lK9VbsTqW1A2zYb1bEPwi-EXOAAXMtaAnSEndzSvxxM,22608
+sleap_share/config.py,sha256=xB1Kq2nuMK2LGOdhKNWP9MXjkzpN_fzc1NSp0H9S7ZE,2838
+sleap_share/exceptions.py,sha256=FgvEVXVg2oOyw7_p2MIv0hl_IM8oiaN_NFT-w78wKOY,3542
+sleap_share/models.py,sha256=vMZWUlpQLCHwZapewkhzoFDhcOz-A96tFPkNb7VqJ8Q,9868
+sleap_share-0.1.2.dist-info/METADATA,sha256=bIFQboObP9uzJXsgn7W_29xvF4zx5AYglBpDVlO36zo,5172
+sleap_share-0.1.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+sleap_share-0.1.2.dist-info/entry_points.txt,sha256=WuUXF_ot7zCvjYZklS_BXd871gRi-Q86xXpyIrRJJ6Y,52
+sleap_share-0.1.2.dist-info/RECORD,,

sleap_share-0.1.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

sleap_share-0.1.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sleap-share = sleap_share.cli:app