fountain-py 0.1.0__tar.gz

fountain_py-0.1.0/.gitignore

@@ -0,0 +1,210 @@
+# Testing stuff for now
+*macbeth*
+scratchpad.md
+.claude/*
+commit-msg.md
+goal.md
+.ai-sessions/handoffs/
+.token.txt
+
+# 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.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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__/

fountain_py-0.1.0/.vale.ini

@@ -0,0 +1,69 @@
+# Vale configuration for the fountain-py docs (reStructuredText under docs/source).
+#
+# StylesPath points at Mason's shared vale-styles checkout, following the
+# convention in that repo's README (one styles directory per machine that every
+# project points at). Contributors linting locally should set StylesPath to
+# their own checkout of https://github.com/MasonEgger/vale-styles.
+#
+# Vale parses .rst natively. The vale-styles OneSentencePerLine rule skips
+# .. code-block:: / .. doctest:: bodies; note that SentenceLength can still flag
+# the occasional line inside a Sphinx doctest, which is a known limitation.
+#
+# Three base rules are tuned down for this project, in every section below:
+#   FirstUse          off  - the acronyms here (HTML, CSS, JSON, API, UTF) and the
+#                            screenplay terms (INT, EXT, V.O., NOTE) are known to
+#                            the audience or defined by the linked Fountain spec.
+#   BoldBulletHeaders off  - the reference catalogs and landing pages use bold
+#                            labels for reference and navigation, which the writing
+#                            style rules permit for reference material.
+#   FleschReadingEase sug  - a document-level readability nudge, not a per-line fix;
+#                            kept visible as a suggestion rather than a warning.
+
+StylesPath = /home/mmegger/Code/vale-styles/styles
+MinAlertLevel = suggestion
+
+# The tutorial: full technical register. The quickstart closes with a
+# "Next Steps" section rather than a literal "Conclusion" heading.
+[docs/source/quickstart.rst]
+BasedOnStyles = MasonBase, MasonTechnical
+MasonBase.We = suggestion
+MasonBase.Conclusion = NO
+MasonBase.FirstUse = NO
+MasonBase.BoldBulletHeaders = NO
+MasonBase.FleschReadingEase = suggestion
+
+# How-to guides and reference: technical register for the STE clarity rules,
+# but these are not tutorials, so drop the Prerequisites and Conclusion
+# expectations.
+[docs/source/{how-to,reference}/**/*.rst]
+BasedOnStyles = MasonBase, MasonTechnical
+MasonBase.We = suggestion
+MasonBase.Conclusion = NO
+MasonTechnical.Prerequisites = NO
+MasonBase.FirstUse = NO
+MasonBase.BoldBulletHeaders = NO
+MasonBase.FleschReadingEase = suggestion
+
+# Explanation: discursive prose. Base rules only, so the procedural sentence-
+# length cap does not flatten conceptual writing.
+[docs/source/explanation/**/*.rst]
+BasedOnStyles = MasonBase
+MasonBase.Conclusion = NO
+MasonBase.FirstUse = NO
+MasonBase.BoldBulletHeaders = NO
+MasonBase.FleschReadingEase = suggestion
+
+# Landing, install, changelog, contributing, and autodoc stubs: base prose only.
+[docs/source/{index,installation,changelog}.rst]
+BasedOnStyles = MasonBase
+MasonBase.Conclusion = NO
+MasonBase.FirstUse = NO
+MasonBase.BoldBulletHeaders = NO
+MasonBase.FleschReadingEase = suggestion
+
+[docs/source/{contributing,api}/**/*.rst]
+BasedOnStyles = MasonBase
+MasonBase.Conclusion = NO
+MasonBase.FirstUse = NO
+MasonBase.BoldBulletHeaders = NO
+MasonBase.FleschReadingEase = suggestion

fountain_py-0.1.0/CHANGELOG.md

@@ -0,0 +1,61 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-04-09
+
+### Added
+
+#### Parser — Full Fountain Spec Compliance
+- Two-pass parser: title page metadata extraction, then line-by-line element classification
+- All 14 body element types emitted by the parser: scene headings, action, character, dialogue, parenthetical, transitions, notes, boneyard, sections, synopses, dual dialogue, page breaks, centered text, lyrics (the `ElementType` enum has 15 members; the 15th, `TITLE_PAGE`, is not emitted as an element: title page data is parsed into `FountainDocument.metadata`)
+- Forced element prefixes (`.`, `!`, `@`, `>`) override natural detection rules
+- Scene number extraction (`#1#`, `#2A#`)
+- Character extensions (`V.O.`, `O.S.`, `CONT'D`) and automatic continuation detection
+- Section level metadata (`# Act` = level 1, `## Scene` = level 2, etc.)
+- Ellipsis protection on forced scene headings (`.` + alphanumeric only)
+- Arbitrary title page keys (any `Key: Value` pair accepted, not just known fields)
+- Blank-line-before requirement for natural scene headings, character names, and transitions
+- Blank-line-after requirement for transitions
+- Inline note stripping (`[[notes]]` removed from element text in non-note elements)
+- Multi-line note support (`[[note\nspanning\nlines]]`)
+- Dialogue continuation with whitespace-only lines (two spaces preserves blank line in dialogue)
+- Backslash escaping for emphasis markers (`\*` → literal `*`, `\_` → literal `_`)
+- Tabs in action elements are converted to four spaces in the element text at parse time; indentation is preserved in HTML via `white-space: pre-wrap` on `.fountain-action`
+- Inline formatting: bold (`**`), italic (`*`), underline (`_`), bold-italic (`***`)
+
+#### Renderers
+- `HTMLRenderer` with three output modes:
+  - `render(doc)` — pure HTML fragment for embedding (no `<style>` tags)
+  - `render_page(doc)` — standalone HTML with embedded CSS
+  - `get_css()` — raw CSS string for external stylesheet use
+- `FountainRenderer` for round-trip conversion back to Fountain markup
+- All CSS classes namespaced with `fountain-` prefix to prevent framework collisions
+- Screenplay-formatted CSS: Courier font, proper margins, centered dialogue, hidden boneyard
+- Dual dialogue side-by-side layout via flexbox
+- Title page rendering with all standard and custom metadata fields
+
+#### Document Analysis
+- `FountainDocument` container with element access and metadata
+- `get_characters()` — extract unique character names
+- `get_scenes()` — list scene heading elements
+- `get_statistics()` — element counts by type, character count, scene count
+- `to_html()` — convenience method for standalone HTML output
+
+#### Type System
+- Full type hints throughout, strict mypy compliance
+- `FormatType` literal type (`"bold"`, `"italic"`, `"underline"`, `"bold_italic"`)
+- `MetadataValue` union type for element metadata documentation
+- PEP 561 `py.typed` marker for downstream type checking
+
+#### Quality
+- 314 tests with 99% code coverage
+- 38 module-level doctests + 447 Sphinx doctests
+- Supports Python 3.10, 3.11, 3.12, 3.13, 3.14
+- Zero runtime dependencies
+- CI with GitHub Actions across all supported Python versions

fountain_py-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# Contributing to Fountain-Py
+
+We love your input! We want to make contributing to this project as easy and transparent as possible.
+
+## Development Process
+
+1. Fork the repo and create your branch from `main`
+2. If you've added code that should be tested, add tests
+3. Ensure the test suite passes
+4. Make sure your code follows the style guidelines
+5. Issue that pull request!
+
+## Development Setup
+
+```bash
+# Clone your fork
+git clone https://github.com/your-username/fountain-py.git
+cd fountain-py
+
+# Install development dependencies
+uv sync --dev
+```
+
+## Running Tests
+
+```bash
+# Run all tests
+uv run pytest
+
+# Run tests with coverage
+uv run pytest --cov=fountain --cov-report=html
+
+# Run specific test file
+uv run pytest tests/test_parser.py
+```
+
+## Code Style
+
+We use:
+- `ruff` for linting and formatting
+- `mypy` for type checking
+- All code must have type hints
+- Follow PEP8 conventions
+
+Run these checks locally:
+```bash
+# Format code
+uv run ruff format src/ tests/
+
+# Check linting
+uv run ruff check src/ tests/
+
+# Type checking
+uv run mypy src/
+```
+
+## Pull Request Process
+
+1. Update the README.md with details of changes if needed
+2. Update the CHANGELOG.md with your changes
+3. The PR will be merged once you have the sign-off of at least one maintainer
+
+## Reporting Bugs
+
+1. Use the GitHub Issues tracker
+2. Include a clear title and description
+3. Provide example code if possible
+4. Include error messages and stack traces
+5. Mention your Python version and OS
+
+## Suggesting Features
+
+1. Open an issue with the "enhancement" label
+2. Clearly describe the feature and its use case
+3. Provide examples of how it would work
+4. Be open to discussion and feedback
+
+## Code of Conduct
+
+Please note we have a code of conduct. Follow it in all your interactions with the project.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

fountain_py-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mason Egger
+
+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.

fountain_py-0.1.0/PKG-INFO

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: fountain-py
+Version: 0.1.0
+Summary: A Python library for parsing Fountain markup, the screenwriting format
+Project-URL: Homepage, https://github.com/MasonEgger/fountain-py
+Project-URL: Repository, https://github.com/MasonEgger/fountain-py
+Project-URL: Documentation, https://masonegger.github.io/fountain-py/
+Project-URL: Issues, https://github.com/MasonEgger/fountain-py/issues
+Author-email: Mason Egger <mason@masonegger.com>
+License-File: LICENSE
+Keywords: fountain,parser,screenplay,screenwriting,script,theater
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Fountain-Py
+
+[![CI](https://github.com/MasonEgger/fountain-py/workflows/CI/badge.svg)](https://github.com/MasonEgger/fountain-py/actions?query=workflow%3ACI)
+[![Python versions](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+A Python library for parsing [Fountain markup](https://fountain.io/), the screenwriting format. Fountain-Py converts Fountain scripts into structured Python objects and can render them as HTML.
+
+## Features
+
+- **Full Fountain Support**: Parses all Fountain elements including scenes, dialogue, action, transitions, notes, dual dialogue, lyrics, and inline emphasis
+- **Validation**: Reports structural problems (unclosed comments and notes, orphaned character cues) through a validation API
+- **Multiple Render Modes**: HTML fragments for embedding, full pages with CSS, or raw CSS for custom styling
+- **Round-Trip and Export**: Write a parsed script back to clean Fountain, or export it to JSON
+- **Type-Safe**: Built with full type hints and strict mypy compliance
+- **Zero Dependencies**: Pure Python with no runtime dependencies
+- **Well-Tested**: Unit tests and doctests across every module, with high coverage enforced in CI
+- **Modern Python**: Supports Python 3.10 through 3.14
+
+## Quick Start
+
+### Installation
+
+Fountain-Py is not on PyPI yet (the 0.1.0 release is pending), so install it from source:
+
+```bash
+pip install git+https://github.com/MasonEgger/fountain-py.git
+```
+
+Once it is published, `pip install fountain-py` will work.
+
+### Basic Usage
+
+```python
+from fountain import FountainParser
+from fountain.renderer import HTMLRenderer
+
+# Parse a Fountain script
+parser = FountainParser()
+document = parser.parse("""Title: My Screenplay
+Author: Jane Writer
+
+INT. COFFEE SHOP - DAY
+
+SARAH enters, looking tired.
+
+SARAH
+One large cappuccino, please!
+""")
+
+# Access parsed data
+print(document.metadata["title"])       # "My Screenplay"
+print(document.get_characters())        # ["SARAH"]
+print(len(document.elements))           # 3
+
+# Render as HTML fragment (for embedding in web pages)
+renderer = HTMLRenderer()
+html_fragment = renderer.render(document)
+
+# Render as standalone HTML file with embedded CSS
+html_page = renderer.render_page(document)
+
+# Get raw CSS for external stylesheets
+css = renderer.get_css()
+```
+
+### Rendering Modes
+
+```python
+renderer = HTMLRenderer()
+
+# Fragment — no <style> tags, just the screenplay markup
+# Use this for embedding in web pages, docs, or CMS systems
+fragment = renderer.render(document)
+
+# Full page — self-contained HTML with embedded CSS
+# Use this for saving as .html files or previewing
+page = renderer.render_page(document)
+
+# Raw CSS — for custom stylesheet integration
+# Use this with mkdocs, static site generators, or your own build pipeline
+css = renderer.get_css()
+```
+
+### Round-Trip Conversion
+
+```python
+from fountain.renderer import FountainRenderer
+
+# Convert back to Fountain markup
+fountain_renderer = FountainRenderer()
+fountain_text = fountain_renderer.render(document)
+```
+
+The round trip preserves element structure and inline emphasis.
+Scene headings, action, character cues, parentheticals, dialogue, transitions, dual dialogue, lyrics, sections, synopses, and notes all keep their element types through `parse(render(parse(text)))`, and the blank lines that separate structural blocks survive so blocks are not merged on re-parse.
+
+Inline emphasis is re-emitted too.
+The parser records the bold (`**`), italic (`*`), and underline (`_`) delimiters as formatting spans, and `FountainRenderer` restores them, so a `**bold**` word round-trips as `**bold**`, including nested emphasis and backslash-escaped literals.
+
+## Documentation
+
+Full documentation is available at [masonegger.github.io/fountain-py](https://masonegger.github.io/fountain-py/).
+
+- [Installation Guide](https://masonegger.github.io/fountain-py/installation.html)
+- [Quick Start Tutorial](https://masonegger.github.io/fountain-py/quickstart.html)
+- [API Reference](https://masonegger.github.io/fountain-py/api/index.html)
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/MasonEgger/fountain-py.git
+cd fountain-py
+
+# Install with development and docs dependencies
+just dev && uv sync --group docs
+```
+
+### Running Tests
+
+```bash
+# Run comprehensive quality checks (tests, coverage, doctests, lint, type check)
+just test
+
+# Run only unit tests
+just unit-test
+
+# Run tests with coverage
+just unit-test-cov
+
+# Run specific tests
+uv run pytest tests/test_parser.py
+```
+
+### Code Quality
+
+```bash
+just lint         # Lint check (ruff)
+just format       # Format code (ruff)
+just type-check   # Type checking (mypy strict)
+```
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+
+## Fountain Format
+
+Fountain is a simple markup syntax for writing, editing and sharing screenplays in plain text. Learn more at [fountain.io](https://fountain.io/).
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- The [Fountain](https://fountain.io/) format creators
+- The screenwriting community for feedback and testing