molbo 0.1.0__tar.gz

molbo-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,58 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Install docs dependencies
+        run: uv sync --group dev
+
+      - name: Build docs
+        run: uv run zensical build
+
+      - name: Configure Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

molbo-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,50 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types:
+      - published
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: pypi
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

molbo-0.1.0/.gitignore

@@ -0,0 +1,2 @@
+__pycache__/
+*.py[cod]

molbo-0.1.0/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: molbo
+Version: 0.1.0
+Summary: Inspect PDB/CIF molecular structures from the command line
+Author: molbo contributors
+License-Expression: MIT
+Keywords: cif,cli,molbo,molecular,molstar,pdb,structure,viewer
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Classifier: Topic :: Scientific/Engineering :: Chemistry
+Requires-Python: >=3.10
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.9.0
+Description-Content-Type: text/markdown
+
+# Molbo
+
+[![Support](https://img.shields.io/pypi/status/molbo?label=support&color=f3c539)](https://pypi.org/project/molbo/) [![PyPI](https://img.shields.io/pypi/v/molbo?label=pypi&color=107cb8)](https://pypi.org/project/molbo/)
+
+<p align="center">
+  <img src="docs/static/molbo-logo.png" width="50%" alt="poorly drawn molbo logo">
+</p>
+
+## Overview
+
+`molbo` is a command-line launcher for interactive molecular structure viewing in [Mol*](https://molstar.org/). It accepts local structure files, remote structure URLs, 4-character PDB IDs, and starts a small HTTP server that serves a self-contained Mol* viewer from vendored frontend assets.
+
+## Installation
+
+```bash
+uv tool install molbo
+```
+
+## Usage
+
+Opening a structure is as easy as:
+
+```bash
+molbo structure.pdb
+```
+
+Read [the documentation](https://leightonpayne.github.io/molbo/) for more information on what `molbo` can do.
+
+## License
+
+`molbo` is released under the [MIT license](https://choosealicense.com/licenses/mit/). The package also vendors frontend assets available under the [MIT license](https://choosealicense.com/licenses/mit/). See `src/molbo/vendor/LICENSE-molstar` and `src/molbo/vendor/LICENSE-qrcode-generator` for more information.

molbo-0.1.0/README.md

@@ -0,0 +1,31 @@
+# Molbo
+
+[![Support](https://img.shields.io/pypi/status/molbo?label=support&color=f3c539)](https://pypi.org/project/molbo/) [![PyPI](https://img.shields.io/pypi/v/molbo?label=pypi&color=107cb8)](https://pypi.org/project/molbo/)
+
+<p align="center">
+  <img src="docs/static/molbo-logo.png" width="50%" alt="poorly drawn molbo logo">
+</p>
+
+## Overview
+
+`molbo` is a command-line launcher for interactive molecular structure viewing in [Mol*](https://molstar.org/). It accepts local structure files, remote structure URLs, 4-character PDB IDs, and starts a small HTTP server that serves a self-contained Mol* viewer from vendored frontend assets.
+
+## Installation
+
+```bash
+uv tool install molbo
+```
+
+## Usage
+
+Opening a structure is as easy as:
+
+```bash
+molbo structure.pdb
+```
+
+Read [the documentation](https://leightonpayne.github.io/molbo/) for more information on what `molbo` can do.
+
+## License
+
+`molbo` is released under the [MIT license](https://choosealicense.com/licenses/mit/). The package also vendors frontend assets available under the [MIT license](https://choosealicense.com/licenses/mit/). See `src/molbo/vendor/LICENSE-molstar` and `src/molbo/vendor/LICENSE-qrcode-generator` for more information.

molbo-0.1.0/docs/about/contributing.md

@@ -0,0 +1,49 @@
+---
+icon: lucide/heart-handshake
+---
+
+# Contributing
+
+Contributions to `molbo` are welcome.
+
+## Quick Start
+
+    git clone https://github.com/leightonpayne/molbo.git
+    cd molbo
+    uv sync
+
+## Development Commands
+
+| Command                 | Description                 |
+| ----------------------- | --------------------------- |
+| `uv run python -m unittest discover -s tests -v` | Run tests |
+| `uv run zensical serve` | Serve docs locally |
+| `uv run zensical build` | Build docs locally |
+| `uv build` | Build sdist and wheel |
+
+## Project Structure
+
+    src/molbo/
+    ├── cli.py        # Typer CLI entrypoint
+    ├── server.py     # Local HTTP server
+    ├── viewer.html   # Browser UI template
+    └── vendor/       # Vendored frontend assets
+
+## Making Changes
+
+1. Make changes in `src/molbo/`
+2. Run the test suite
+3. If you changed docs, preview them with Zensical
+4. If you changed packaged assets or templates, check `uv build`
+
+## Submitting Changes
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests and linting
+5. Submit a pull request
+
+## Release Process
+
+Maintainers should verify both the test suite and the built wheel before publishing a release.

molbo-0.1.0/docs/about/identity.md

@@ -0,0 +1,21 @@
+---
+icon: lucide/paintbrush
+---
+
+# Identity
+
+## Name
+
+"Molbo" (/ˈmɔlˌpoˀ/) is a Danish cow's milk cheese made in Mols. For the purposes of this package, it is a portmanteau of *Mol\** and *browser*.
+
+## Logo
+
+The typeface is [Isobare](https://www.clemencefontaine.fr/page/isobar.html), designed by Clémence Fontaine and licensed under the [SIL Open Font License, Version 1.1](https://openfontlicense.org/).
+
+<p align="center">
+  <img src="../../static/molbo-mascot.png" width="80" alt="Molbo mascot">
+</p>
+
+<p align="center">
+  <img src="../../static/molbo-logo.png" width="200" alt="Molbo logo">
+</p>

molbo-0.1.0/docs/about/installation.md

@@ -0,0 +1,29 @@
+---
+icon: lucide/package
+---
+
+# Installation
+
+## Install as a CLI tool with uv
+
+For normal use, install `molbo` globally with `uv`:
+
+```bash
+uv tool install molbo
+```
+
+## Development setup
+
+If you are working from a clone of the repository:
+
+```bash
+git clone https://github.com/leightonpayne/molbo.git
+cd molbo
+uv sync
+```
+
+Run the CLI from the project environment with:
+
+```bash
+uv run molbo
+```

molbo-0.1.0/docs/about/license.md

@@ -0,0 +1,12 @@
+---
+icon: lucide/scale
+---
+
+# License
+
+`molbo` is released under the MIT license.
+
+The package also vendors frontend assets with their own license files:
+
+- `src/molbo/vendor/LICENSE-molstar`
+- `src/molbo/vendor/LICENSE-qrcode-generator`

molbo-0.1.0/docs/index.md

@@ -0,0 +1,25 @@
+---
+icon: lucide/house
+---
+
+# Molbo
+
+<p align="center">
+  <img src="static/molbo-logo.png" width="50%" alt="molbo logo">
+</p>
+
+## Overview
+
+`molbo` is a command-line launcher for interactive molecular structure viewing in [Mol*](https://molstar.org/). It accepts local structure files, remote structure URLs, 4-character PDB IDs, and starts a small HTTP server that serves a self-contained Mol* viewer from vendored frontend assets.
+
+## What it is for
+
+`molbo` is meant to make it fast to go from a structure identifier or file on disk to an interactive browser session. It is useful both for private inspection on your own machine and for lightweight sharing through a tailnet, tunnel, or reverse proxy.
+
+## Getting Started
+
+Start with [Installation](about/installation.md), then see:
+
+- [Quickstart](usage/quickstart.md)
+- [Inputs](usage/inputs.md)
+- [Sharing Sessions](usage/sharing.md)