toss-cli 1.0.0__tar.gz

toss_cli-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

toss_cli-1.0.0/.gitignore

@@ -0,0 +1,208 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+assets/test/

toss_cli-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Valérien
+
+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.

toss_cli-1.0.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: toss-cli
+Version: 1.0.0
+Summary: Minimal CLI to deploy and share static sites, HTML, and Markdown from your own server.
+Project-URL: Homepage, https://github.com/brayevalerien/toss
+Project-URL: Repository, https://github.com/brayevalerien/toss
+Author-email: Valérien <contact@brayevalerien.com>
+License: MIT License
+        
+        Copyright (c) 2026 Valérien
+        
+        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.
+License-File: LICENSE
+Keywords: caddy,cli,deploy,file-sharing,latex,markdown,rsync,self-hosted,static-site
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img src="assets/logo-circle.svg" alt="toss logo" width="96" />
+</div>
+
+# Toss
+Toss is a minimal CLI to deploy and share static sites, HTML, and Markdown from your own server. Fast configuration and easy to setup so you can use it from about everywhere and share your work with private URLs.
+
+## Features
+- Deploy a Markdown file, an HTML file, or a full directory with a single command
+- Markdown pages render in the browser with LaTeX (KaTeX), syntax highlighting, footnotes, callouts, and Mermaid diagrams
+- Random slugs by default, custom slugs with `--slug`
+- Build-and-deploy in one step with `--build`
+- List, hide, unhide, and permanently delete deployments
+- Zero server-side dependencies beyond Caddy and SSH access
+
+## Installation and setup
+> [!NOTE]
+> The following prerequisites are needed before installing toss.
+> - [Python](https://www.python.org/) 3.10+
+> - [uv](https://docs.astral.sh/uv/)
+> - [git](https://git-scm.com/)
+> - `rsync` and `ssh` available in PATH (client-side)
+> - SSH access to a server running [Caddy](https://caddyserver.com/)
+
+### Server-side setup
+You'll first need to configure your server to serve files through SSH and [Caddy](https://caddyserver.com/).
+This section assumes you are running the commands on your server.
+
+Add a DNS A record: `share` (or anything you like) pointing to your server IP.
+
+Create the sites directory and give your SSH user write access:
+```sh
+sudo mkdir -p /srv/sites
+sudo chown youruser:youruser /srv/sites
+```
+
+Add a block to your Caddyfile for the share subdomain:
+```
+share.yourdomain.com {
+    root * /srv/sites
+    file_server
+    header X-Robots-Tag "noindex, nofollow"
+    handle_errors {
+        rewrite * /404.html
+        file_server
+    }
+}
+```
+
+If running Caddy in Docker, also mount `/srv/sites` in your Caddy container's volumes:
+```yaml
+volumes:
+  - /srv/sites:/srv/sites:ro
+```
+
+Copy the 404 page to your server. Feel free to edit `assets/404.html` to add your own contact info, and edit `toss_cli/templates/markdown_page.html` to customize the Markdown rendering theme before installing:
+```sh
+scp assets/404.html user@your-server:/srv/sites/404.html
+```
+
+Then restart Caddy:
+```sh
+# assuming systemd
+sudo systemctl reload caddy
+# or if using Docker
+docker compose up -d caddy
+```
+
+### Local CLI
+Once the server is configured, clone the repo and install toss locally:
+```sh
+git clone https://github.com/brayevalerien/toss
+cd toss
+uv tool install .
+```
+
+Once toss is installed, run the interactive setup wizard once:
+```sh
+toss init
+```
+This will prompt you for your server details, validate SSH connectivity, and save a config file at `~/.config/toss/config.toml`.
+
+> [!NOTE]
+> Re-run `toss init` at any time to update your configuration. If you prefer to edit it manually, it uses the following format:
+> ```toml
+> host = "user@my-server"
+> domain = "share.mydomain.com"
+> remote_path = "/srv/sites"
+> slug_length = 6
+> ```
+
+## Usage
+
+```sh
+# deploy a Markdown file, an HTML file, or a directory
+toss deploy path/to/file.md
+toss deploy path/to/page.html
+toss deploy path/to/site/
+
+# custom slug
+toss deploy report.md --slug my-report
+
+# build then deploy
+toss deploy . --build "npm run build"
+toss deploy . --build "npm run build" --out dist
+
+# list all deployments
+toss list
+
+# hide (makes URL return 404) and unhide
+toss hide <slug>
+toss unhide <slug>
+
+# permanently delete
+toss undeploy <slug>
+```

toss_cli-1.0.0/README.md

@@ -0,0 +1,116 @@
+<div align="center">
+  <img src="assets/logo-circle.svg" alt="toss logo" width="96" />
+</div>
+
+# Toss
+Toss is a minimal CLI to deploy and share static sites, HTML, and Markdown from your own server. Fast configuration and easy to setup so you can use it from about everywhere and share your work with private URLs.
+
+## Features
+- Deploy a Markdown file, an HTML file, or a full directory with a single command
+- Markdown pages render in the browser with LaTeX (KaTeX), syntax highlighting, footnotes, callouts, and Mermaid diagrams
+- Random slugs by default, custom slugs with `--slug`
+- Build-and-deploy in one step with `--build`
+- List, hide, unhide, and permanently delete deployments
+- Zero server-side dependencies beyond Caddy and SSH access
+
+## Installation and setup
+> [!NOTE]
+> The following prerequisites are needed before installing toss.
+> - [Python](https://www.python.org/) 3.10+
+> - [uv](https://docs.astral.sh/uv/)
+> - [git](https://git-scm.com/)
+> - `rsync` and `ssh` available in PATH (client-side)
+> - SSH access to a server running [Caddy](https://caddyserver.com/)
+
+### Server-side setup
+You'll first need to configure your server to serve files through SSH and [Caddy](https://caddyserver.com/).
+This section assumes you are running the commands on your server.
+
+Add a DNS A record: `share` (or anything you like) pointing to your server IP.
+
+Create the sites directory and give your SSH user write access:
+```sh
+sudo mkdir -p /srv/sites
+sudo chown youruser:youruser /srv/sites
+```
+
+Add a block to your Caddyfile for the share subdomain:
+```
+share.yourdomain.com {
+    root * /srv/sites
+    file_server
+    header X-Robots-Tag "noindex, nofollow"
+    handle_errors {
+        rewrite * /404.html
+        file_server
+    }
+}
+```
+
+If running Caddy in Docker, also mount `/srv/sites` in your Caddy container's volumes:
+```yaml
+volumes:
+  - /srv/sites:/srv/sites:ro
+```
+
+Copy the 404 page to your server. Feel free to edit `assets/404.html` to add your own contact info, and edit `toss_cli/templates/markdown_page.html` to customize the Markdown rendering theme before installing:
+```sh
+scp assets/404.html user@your-server:/srv/sites/404.html
+```
+
+Then restart Caddy:
+```sh
+# assuming systemd
+sudo systemctl reload caddy
+# or if using Docker
+docker compose up -d caddy
+```
+
+### Local CLI
+Once the server is configured, clone the repo and install toss locally:
+```sh
+git clone https://github.com/brayevalerien/toss
+cd toss
+uv tool install .
+```
+
+Once toss is installed, run the interactive setup wizard once:
+```sh
+toss init
+```
+This will prompt you for your server details, validate SSH connectivity, and save a config file at `~/.config/toss/config.toml`.
+
+> [!NOTE]
+> Re-run `toss init` at any time to update your configuration. If you prefer to edit it manually, it uses the following format:
+> ```toml
+> host = "user@my-server"
+> domain = "share.mydomain.com"
+> remote_path = "/srv/sites"
+> slug_length = 6
+> ```
+
+## Usage
+
+```sh
+# deploy a Markdown file, an HTML file, or a directory
+toss deploy path/to/file.md
+toss deploy path/to/page.html
+toss deploy path/to/site/
+
+# custom slug
+toss deploy report.md --slug my-report
+
+# build then deploy
+toss deploy . --build "npm run build"
+toss deploy . --build "npm run build" --out dist
+
+# list all deployments
+toss list
+
+# hide (makes URL return 404) and unhide
+toss hide <slug>
+toss unhide <slug>
+
+# permanently delete
+toss undeploy <slug>
+```

toss_cli-1.0.0/assets/404.html

@@ -0,0 +1,107 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="robots" content="noindex, nofollow">
+  <title>404</title>
+  <style>
+    * {
+      margin: 0;
+      padding: 0;
+      box-sizing: border-box;
+    }
+
+    body {
+      background: #272822;
+      color: #f8f8f2;
+      font-family: 'SF Mono', 'Fira Code', 'JetBrains Mono', monospace;
+      height: 100dvh;
+      display: flex;
+      align-items: center;
+      justify-content: center;
+      -webkit-font-smoothing: antialiased;
+    }
+
+    .layout {
+      display: flex;
+      align-items: center;
+      gap: 3rem;
+    }
+
+    .code {
+      font-size: 8rem;
+      font-weight: 700;
+      color: #ae81ff;
+      line-height: 1;
+      letter-spacing: -0.04em;
+    }
+
+    .divider {
+      width: 1px;
+      height: 8rem;
+      background: #75715e;
+      opacity: 0.4;
+    }
+
+    .right {
+      display: flex;
+      flex-direction: column;
+      align-items: flex-start;
+      gap: 1rem;
+    }
+
+    .logo {
+      width: 56px;
+      height: 56px;
+      opacity: 0.7;
+    }
+
+    .msg {
+      font-size: 0.85rem;
+      color: #75715e;
+      line-height: 1.7;
+    }
+
+    .msg a {
+      color: #66d9ef;
+      text-decoration: none;
+      border-bottom: 1px solid transparent;
+      transition: border-color 0.2s;
+    }
+
+    .msg a:hover {
+      border-color: #66d9ef;
+    }
+  </style>
+</head>
+
+<body>
+  <div class="layout">
+    <div class="code">404</div>
+    <div class="divider"></div>
+    <div class="right">
+      <svg class="logo" viewBox="0 0 512 512" xmlns="http://www.w3.org/2000/svg">
+        <defs>
+          <linearGradient id="g" x1="0" y1="1" x2="0.5" y2="0">
+            <stop offset="0%" stop-color="#f92672" />
+            <stop offset="100%" stop-color="#ae81ff" />
+          </linearGradient>
+        </defs>
+        <path d="M144 380 L256 190 L368 380" stroke="url(#g)" stroke-width="48" stroke-linecap="round"
+          stroke-linejoin="round" fill="none" />
+        <rect x="204" y="142" width="104" height="12" rx="6" fill="#a6e22e" opacity="0.9" />
+        <rect x="220" y="114" width="72" height="12" rx="6" fill="#a6e22e" opacity="0.55" />
+        <rect x="240" y="86" width="32" height="12" rx="6" fill="#a6e22e" opacity="0.25" />
+      </svg>
+      <p class="msg">
+        This page doesn't exist.<br>
+        Contact the website owner<br>
+        if this link is broken.
+      </p>
+    </div>
+  </div>
+</body>
+
+</html>

toss_cli-1.0.0/assets/logo-circle.svg

@@ -0,0 +1,20 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" width="512" height="512">
+  <defs>
+    <linearGradient id="accent" x1="0" y1="1" x2="0.5" y2="0">
+      <stop offset="0%" stop-color="#f92672"/>
+      <stop offset="100%" stop-color="#ae81ff"/>
+    </linearGradient>
+  </defs>
+  
+  <!-- Background circle -->
+  <circle cx="256" cy="256" r="240" fill="#272822"/>
+  
+  <!-- Chevron - tighter angle -->
+  <path d="M144 380 L256 190 L368 380" 
+        stroke="url(#accent)" stroke-width="48" stroke-linecap="round" stroke-linejoin="round" fill="none"/>
+  
+  <!-- Detaching particles -->
+  <rect x="204" y="142" width="104" height="12" rx="6" fill="#a6e22e" opacity="0.9"/>
+  <rect x="220" y="114" width="72" height="12" rx="6" fill="#a6e22e" opacity="0.55"/>
+  <rect x="240" y="86" width="32" height="12" rx="6" fill="#a6e22e" opacity="0.25"/>
+</svg>

toss_cli-1.0.0/assets/logo.svg

@@ -0,0 +1,23 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" width="512" height="512">
+  <defs>
+    <linearGradient id="accent" x1="0" y1="1" x2="0.5" y2="0">
+      <stop offset="0%" stop-color="#f92672"/>
+      <stop offset="100%" stop-color="#ae81ff"/>
+    </linearGradient>
+    <clipPath id="circle-clip">
+      <circle cx="256" cy="256" r="240"/>
+    </clipPath>
+  </defs>
+  
+  <!-- Background rounded square -->
+  <rect x="16" y="16" width="480" height="480" rx="96" fill="#272822"/>
+  
+  <!-- Chevron - tighter angle -->
+  <path d="M144 380 L256 190 L368 380" 
+        stroke="url(#accent)" stroke-width="48" stroke-linecap="round" stroke-linejoin="round" fill="none"/>
+  
+  <!-- Detaching particles -->
+  <rect x="204" y="142" width="104" height="12" rx="6" fill="#a6e22e" opacity="0.9"/>
+  <rect x="220" y="114" width="72" height="12" rx="6" fill="#a6e22e" opacity="0.55"/>
+  <rect x="240" y="86" width="32" height="12" rx="6" fill="#a6e22e" opacity="0.25"/>
+</svg>