vividly 0.0.1__tar.gz

vividly-0.0.1/LICENSE

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

vividly-0.0.1/MANIFEST.in

@@ -0,0 +1,2 @@
+graft src/vividly/resources
+global-exclude *.py[cod]

vividly-0.0.1/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: vividly
+Version: 0.0.1
+Summary: Vividly presentation builder and runner
+Author: Michael Hopcroft
+License-Expression: MIT
+Keywords: presentations,slides,web
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pillow>=12.3.0
+Requires-Dist: playwright>=1.62.0
+Dynamic: license-file
+
+# Vividly
+
+Vividly is a toolkit for building, previewing, and publishing interactive web
+presentations. A presentation is a self-contained [single-page web app (SPA)](https://en.wikipedia.org/wiki/Single-page_application) composed of
+independently authored slides and a manifest that determines their order and
+configuration.
+
+Vividly is currently **pre-alpha**. The presentation runtime and local preview
+server are under active development; the initialization, update, and publishing
+commands are not yet implemented.
+
+## Requirements
+
+- Python 3.12 or later
+- A modern web browser
+
+## Installation
+
+Once Vividly is published to PyPI, install it as a command-line tool with
+[uv](https://docs.astral.sh/uv/):
+
+~~~console
+uv tool install vividly
+~~~
+
+Alternatively, install it into a Python environment with pip:
+
+~~~console
+python -m pip install vividly
+~~~
+
+## Presentation layout
+
+A Vividly presentation project consists of a deployable website root and a collection of resources to assist in coding agents when authoring slides.
+
+~~~text
+my-presentation/
+├── .github/
+│   ├── copilot-instructions.md
+│   ├── instructions/
+│   └── skills/
+├── vividly/
+│   └── docs/
+└── site/
+	├── index.html
+	├── vividly/
+	│   └── (runtime files and folders)
+	└── slides/
+		├── presentation.yaml
+		└── (slide folders ...)
+~~~
+
+The hosted site contains the default entry point, index.html, along with a local copy of the Vividly
+runtime, and a collection of slides referenced by the manifest in presentation.yaml.
+
+The project-level documentation, instructions, and skills help coding agents
+understand the Vividly runtime and its presentation-authoring conventions.
+
+## Previewing a presentation
+
+From a presentation's root directory, serve its `site/` folder locally:
+
+~~~console
+vividly run
+~~~
+
+The presentation root can also be supplied explicitly:
+
+~~~console
+vividly run path/to/my-presentation
+~~~
+
+The server listens on port 8080 by default. To use another port:
+
+~~~console
+vividly run --port 9000
+~~~
+
+Then open the displayed local URL in a browser. The preview server is intended
+for local development, not production hosting.
+
+## Commands
+
+| Command | Purpose | Status |
+| --- | --- | --- |
+| `vividly init` | Create a new presentation with sample slides | Planned |
+| `vividly update` | Update the bundled Vividly runtime | Planned |
+| `vividly run` | Preview the presentation locally | Available |
+| `vividly publish` | Publish the presentation | Planned |
+
+Run `vividly --help` or `vividly <command> --help` for command-line help.
+
+## Development
+
+The project uses [uv](https://docs.astral.sh/uv/) for environment and dependency
+management. Clone the repository and synchronize the development environment:
+
+~~~console
+uv sync
+~~~
+
+Run the CLI from within the repo:
+
+~~~console
+uv run vividly --help
+~~~
+
+To preview the starter presentation from within the Vividly repo:
+
+~~~console
+uv run vividly run src/vividly/resources/starter-project
+~~~
+
+Check the Python source with Ruff:
+
+~~~console
+uv run ruff check .
+~~~
+
+Run the automated tests:
+
+~~~console
+uv run pytest
+~~~
+
+## Project links
+
+Coming soon
+
+## License
+
+Vividly is available under the [MIT License](LICENSE).

vividly-0.0.1/README.md

@@ -0,0 +1,132 @@
+# Vividly
+
+Vividly is a toolkit for building, previewing, and publishing interactive web
+presentations. A presentation is a self-contained [single-page web app (SPA)](https://en.wikipedia.org/wiki/Single-page_application) composed of
+independently authored slides and a manifest that determines their order and
+configuration.
+
+Vividly is currently **pre-alpha**. The presentation runtime and local preview
+server are under active development; the initialization, update, and publishing
+commands are not yet implemented.
+
+## Requirements
+
+- Python 3.12 or later
+- A modern web browser
+
+## Installation
+
+Once Vividly is published to PyPI, install it as a command-line tool with
+[uv](https://docs.astral.sh/uv/):
+
+~~~console
+uv tool install vividly
+~~~
+
+Alternatively, install it into a Python environment with pip:
+
+~~~console
+python -m pip install vividly
+~~~
+
+## Presentation layout
+
+A Vividly presentation project consists of a deployable website root and a collection of resources to assist in coding agents when authoring slides.
+
+~~~text
+my-presentation/
+├── .github/
+│   ├── copilot-instructions.md
+│   ├── instructions/
+│   └── skills/
+├── vividly/
+│   └── docs/
+└── site/
+	├── index.html
+	├── vividly/
+	│   └── (runtime files and folders)
+	└── slides/
+		├── presentation.yaml
+		└── (slide folders ...)
+~~~
+
+The hosted site contains the default entry point, index.html, along with a local copy of the Vividly
+runtime, and a collection of slides referenced by the manifest in presentation.yaml.
+
+The project-level documentation, instructions, and skills help coding agents
+understand the Vividly runtime and its presentation-authoring conventions.
+
+## Previewing a presentation
+
+From a presentation's root directory, serve its `site/` folder locally:
+
+~~~console
+vividly run
+~~~
+
+The presentation root can also be supplied explicitly:
+
+~~~console
+vividly run path/to/my-presentation
+~~~
+
+The server listens on port 8080 by default. To use another port:
+
+~~~console
+vividly run --port 9000
+~~~
+
+Then open the displayed local URL in a browser. The preview server is intended
+for local development, not production hosting.
+
+## Commands
+
+| Command | Purpose | Status |
+| --- | --- | --- |
+| `vividly init` | Create a new presentation with sample slides | Planned |
+| `vividly update` | Update the bundled Vividly runtime | Planned |
+| `vividly run` | Preview the presentation locally | Available |
+| `vividly publish` | Publish the presentation | Planned |
+
+Run `vividly --help` or `vividly <command> --help` for command-line help.
+
+## Development
+
+The project uses [uv](https://docs.astral.sh/uv/) for environment and dependency
+management. Clone the repository and synchronize the development environment:
+
+~~~console
+uv sync
+~~~
+
+Run the CLI from within the repo:
+
+~~~console
+uv run vividly --help
+~~~
+
+To preview the starter presentation from within the Vividly repo:
+
+~~~console
+uv run vividly run src/vividly/resources/starter-project
+~~~
+
+Check the Python source with Ruff:
+
+~~~console
+uv run ruff check .
+~~~
+
+Run the automated tests:
+
+~~~console
+uv run pytest
+~~~
+
+## Project links
+
+Coming soon
+
+## License
+
+Vividly is available under the [MIT License](LICENSE).

vividly-0.0.1/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vividly"
+version = "0.0.1"
+description = "Vividly presentation builder and runner"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Michael Hopcroft" }]
+keywords = ["presentations", "slides", "web"]
+classifiers = [
+	"Development Status :: 2 - Pre-Alpha",
+	"Environment :: Console",
+	"Operating System :: OS Independent",
+	"Programming Language :: Python :: 3",
+	"Programming Language :: Python :: 3.12",
+	"Programming Language :: Python :: 3.13",
+	"Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "pillow>=12.3.0",
+    "playwright>=1.62.0",
+]
+
+[project.scripts]
+vividly = "vividly.cli:main"
+
+[dependency-groups]
+dev = [
+	"pytest>=8.4",
+	"ruff>=0.14",
+]
+
+[tool.uv]
+package = true
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+
+[tool.pyright]
+typeCheckingMode = "strict"
+pythonVersion = "3.12"
+include = ["src", "tests"]

vividly-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vividly-0.0.1/src/vividly/__init__.py

@@ -0,0 +1 @@
+"""Vividly presentation builder and runner."""