pygodide 0.1.0__tar.gz

pygodide-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Documentation
+    url: https://elan456.github.io/pygodide/
+    about: Setup guide for getting your Pygame app running in the browser

pygodide-0.1.0/.github/ISSUE_TEMPLATE/conversion-failure.yml

@@ -0,0 +1,46 @@
+name: "My project didn't convert"
+description: Something went wrong turning your Pygame project into a web app
+labels:
+  - conversion-failure
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Sorry that it didn't work, but it'll be interesting to figure out why! Please fill out the fields below, so we can make pygodide better for everyone.
+
+        Two things make this easy for us to debug: a quick description of what happened, and your build log. That's it!
+
+        > **Tip:** After running `pygodide build`, your log is at `build/pygodide-build.log`. The CLI prints the path when the build finishes.
+
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: "In your own words: what did you try, and what did you see instead?"
+      placeholder: |
+        I ran `pygodide build . --serve` on my snake game. The build finished, but the browser stays on "Loading..." and never shows the game.
+    validations:
+      required: true
+
+  - type: textarea
+    id: build-log
+    attributes:
+      label: Build log
+      description: "Paste the full contents of `build/pygodide-build.log`. It has everything we need on our end (version, dependencies, errors)."
+      render: shell
+    validations:
+      required: true
+
+  - type: input
+    id: project-link
+    attributes:
+      label: Link to your project (optional)
+      description: A GitHub repo, gist, or zip link helps us reproduce the issue faster.
+      placeholder: "https://github.com/you/my-game"
+
+  - type: textarea
+    id: anything-else
+    attributes:
+      label: Anything else? (optional)
+      description: "Browser console errors (F12 → Console), screenshots, or a link to a smaller repro (only if you have them handy)."
+      placeholder: 'Firefox console says "micropip install failed for ..."'

pygodide-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  workflow_call:
+
+jobs:
+  checks:
+    name: Checks (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        # dev group includes pygodide[smoke] (Playwright package). Unit tests do
+        # not launch browsers, so no "playwright install chromium" here.
+        run: uv sync --dev
+
+      - name: Check formatting
+        run: uv run ruff format --check .
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Run tests
+        run: uv run pytest
+
+      - name: Build distribution artifacts
+        run: uv build
+
+      - name: Smoke test installed CLI
+        run: |
+          python -m venv .wheel-smoke
+          .wheel-smoke/bin/pip install "$(echo dist/*.whl)[smoke]"
+          .wheel-smoke/bin/pygodide --help
+          .wheel-smoke/bin/python -c "import playwright; print('smoke extra ok')"

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

@@ -0,0 +1,34 @@
+name: Docs
+
+on:
+  push:
+    branches: [ main ]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/configure-pages@v5
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+      - run: uv sync --dev
+      - run: uv run zensical build --clean --strict
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: site
+      - uses: actions/deploy-pages@v4
+        id: deployment

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

@@ -0,0 +1,73 @@
+name: Publish
+
+on:
+  release:
+    types:
+      - published
+  workflow_dispatch:
+
+jobs:
+  verify:
+    uses: ./.github/workflows/ci.yml
+
+  smoke:
+    name: Smoke tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Install Playwright browsers
+        run: uv run playwright install --with-deps chromium
+
+      - name: Run smoke target suite
+        run: uv run pygodide smoke test_targets --suite
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs:
+      - verify
+      - smoke
+    permissions:
+      contents: read
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pygodide
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Build distribution artifacts
+        run: uv build
+
+      - name: Publish distribution artifacts
+        uses: pypa/gh-action-pypi-publish@release/v1

pygodide-0.1.0/.gitignore

@@ -0,0 +1,232 @@
+# 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
+*.zip
+
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# AI stuff:
+.codex/
+.agents/
+.hermes/
+
+# Temp / Swap Files
+~*
+# Benchmark local worktrees
+benchmarks/.work/
+benchmarks/.venv/
+benchmarks/output/
+benchmarks/results/

pygodide-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+default_install_hook_types:
+  - pre-commit
+  - pre-push
+
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-format
+        name: ruff format
+        entry: uv run ruff format .
+        language: system
+        pass_filenames: false
+      - id: ruff-check
+        name: ruff check
+        entry: uv run ruff check . --fix
+        language: system
+        pass_filenames: false
+      - id: pytest
+        name: pytest
+        entry: uv run pytest
+        language: system
+        pass_filenames: false
+        stages:
+          - pre-push

pygodide-0.1.0/AGENTS.md

@@ -0,0 +1,177 @@
+# AGENTS.md
+
+The contents of this file are for human contributors as well as the AI tools
+leveraged by those human contributors for working on this project.
+
+This file is mostly handwritten and should act as the north star for
+guiding the project.
+
+## Project
+
+For an overview of the project, read the `README.md` and the `docs/index.md`.
+
+The goal of the project is to create a dead-simple tool for beginner Python
+developers to publish their games easily, while also exposing options for more
+experienced developers to tailor the tool to their needs.
+
+## AI-Rules
+
+- Always acknowledge that you have read this file with "I've read the AGENTS.md"
+  at the start of any chat or task involving the project.
+- Never edit this file (AGENTS.md) even if told to do so explicitly.
+    - Exception: Running a grammar pass (don't change any semantics)
+- Never use any `git` commands.
+    - `git log` and `git diff` are okay
+- If you want to make temp output files or reports, name them with a leading "~" so they get ignored by git automatically. For example: ~analysis_report.md.
+- The top-level README.md is sacred and needs a strong human touch. Be very careful adding AI-generated prose, and make the user very aware.
+- Don't use weird characters that aren't on a keyboard. They look stupid and are hard to work with. (e.g. ·)
+
+### Backwards-Compatibility
+
+The project follows [semver](https://semver.org/) versioning rules, but those
+rules only apply to the user-facing CLI. In practice, this means that every
+minor and patch release must not introduce breaking changes to the user-facing
+CLI, but can change anything around the internal interfaces.
+
+### User-facing CLI
+
+| Command | Role |
+| --- | --- |
+| `pygodide build` | Bundle a project into a webapp, resolve deps, optional auto-async, render `index.html` / `boot.js` |
+| `pygodide serve` | Serve a built app |
+| `pygodide smoke` | Build (and optionally browser-test) an app or suite of apps |
+
+Typer definitions in `pygodide/cli/main.py` are the source of truth for CLI help
+and the docs site CLI reference (`mkdocs-typer2` + Zensical).
+
+## Layout
+
+```text
+pygodide/
+  cli/           # Typer surface (main.py) + runners (runners.py)
+  builder/       # plan, pipeline, zip, display_size (not named "build": that is the output dir)
+  asyncify/      # AST transform of simple sync Pygame loops
+  smoke/         # manifests, suite, Playwright
+  dep_handling/  # collect requirements + Pyodide/micropip install plan
+  logs.py        # shared build/smoke log files (not under builder)
+  rendering.py   # Jinja → index.html / boot.js
+  serving.py     # HTTP serve (CLI forever + ephemeral smoke server)
+  project_config.py / pyproject.py
+  templates/
+tests/           # unit tests
+test_targets/    # fixture apps + testing_manifest.yaml (see test_targets/README.md)
+docs/            # Zensical site
+benchmarks/      # cross-runtime FPS harness (not part of the CLI)
+```
+
+### Code style
+
+- Target Python 3.11+. Ruff for format and lint (`uv run ruff format`, `uv run ruff check`).
+- Prefer small modules with one clear job over mega-files.
+- Frozen dataclasses for config/plan types.
+- Typer options stay in `cli/main.py`; side effects live in `cli/runners.py`.
+
+### Docs and prose
+
+- Docs site: Zensical (`zensical.toml`, `docs/`). CLI reference is generated from
+  Typer via `mkdocs-typer2`.
+- After CLI help/`short_help` changes that affect generated docs, rebuild with
+  `uv run zensical build --clean` when verifying the site (Zensical can cache
+  pages that do not change on disk).
+- Prefer normal ASCII punctuation in repo prose.
+- Don't overuse **bold** and *italics*.
+- Keep contributor-facing docs close to the code they describe (e.g.
+  `test_targets/README.md` for the fixture suite).
+- Do not use the word "staged" (or "staging") for files copied into the build.
+  It is easily confused with git staging. Prefer "copied into the build",
+  "packaged", or "included in the build" in docs, comments, logs, and errors.
+- Prefer short, plain language. Say what is happening and what to do next; avoid jargon, log-style prefixes, and    
+  parenthetical asides when a clearer main sentence works.
+
+### Debuggability
+
+Many novice developers will be using this tool. It is extremely important that
+pygodide prioritizes easy-to-read error messages, obvious failure modes, and
+clear warnings. The pygodide window should never just crash or freeze; it should
+always give a helpful error message that is shown clearly on the webpage.
+Anything that makes pygodide easier to use, or easier to figure out why an app
+won't start on the web, should be prioritized.
+
+### Dependencies
+
+- Runtime deps: `[project].dependencies`.
+- Browser smoke optional extra: `[project.optional-dependencies].smoke`
+  (Playwright). Version is pinned there once.
+- Dev group includes `pygodide[smoke]` so `uv sync --dev` gets the same
+  Playwright pin. Do not duplicate the Playwright version string in `dev`.
+- End users: `pip install 'pygodide[smoke]'` then `playwright install chromium`.
+- Unit tests should not require a Chromium install; real browser smoke does.
+
+## Workflows
+
+### Dev setup
+
+```bash
+uv sync --dev
+uv run playwright install chromium   # only if running real smoke / benchmarks
+```
+
+### Checks (same spirit as CI)
+
+```bash
+uv run ruff format --check .
+uv run ruff check .
+uv run pytest
+```
+
+### Smoke
+
+- One project: `uv run pygodide smoke path/to/app`
+- Fixture suite: `uv run pygodide smoke test_targets --suite`
+- `--build-only`: suite/pipeline without Playwright (still applies manifests,
+  cleans, builds, smoke logs). Not a synonym for bare `pygodide build` on each
+  folder; manifests can override app/deps/auto-async.
+- Fixture schema and how to add targets: `test_targets/README.md`.
+
+### Auto-async
+
+Build-time AST rewrite for simple sync game loops (yield with
+`await asyncio.sleep(1 / (fps * 2))`). Prefer improving detection/transform
+carefully; unsafe transforms should skip with a clear message pointing at manual
+async guidance.
+
+### Writing a test_target
+
+- Use an FPS of 120 to ensure it feels smooth.
+- Write at the edge of pygodide's support so the fixtures act as good regression
+  tests.
+- Keep the code simple and easy to follow so users can read them as examples.
+- Avoid writing for pygodide; write primarily for the local case to imitate what
+  most real-world target Python projects will look like. Pygodide should bend to
+  the project, not the other way around.
+
+## What "done" looks like
+
+- Behavior matches the product goals (build/serve/smoke stay reliable).
+- Names and messages stay clear to game authors, not only to us.
+- Docs/README/`test_targets` guidance updated when contributors need to know
+  about behavior changes.
+
+## Release Notes
+
+- When asked to generate release notes, look at all of the code changes between the current head and the last tagged commit.
+- Write a concise bulleted list of changes.
+- Any breaking changes to the user CLI or how configuration files (e.g. the user's pyproject.toml file) will be interpreted should be put in a "Breaking Changes" section at the top.
+
+Example Release Notes:
+
+0.1.2
+
+- Detect hung games that never yield and show fix guidance on the page
+- Re-show hang help after ready if yielding stops (soft stalls)
+- Smarter auto canvas size (prefer playable set_mode, ignore tiny/NOFRAME dummies)
+- Make crash error panels scrollable and selectable
+- Use Hack font for the loader by default
+- Stop nesting previous zip builds into the next zip
+- Smoke support for expected hang warnings (async_hang fixture)
+- Docs and dependency bumps

pygodide-0.1.0/LICENSE

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