Skip to content

Polish cookbook for public release - #1

Merged
0xspacecreated merged 4 commits into
mainfrom
chore/cookbook-polish
May 16, 2026
Merged

0xspacecreated merged 4 commits into
mainfrom
chore/cookbook-polish

Conversation

@0xspacecreated

@0xspacecreated 0xspacecreated commented May 16, 2026 •

Copy link
Copy Markdown
Contributor

Prepares the NeuroAPI Cookbook for being a public repository, informed by a review of the OpenAI, Gemini, Groq, and xAI cookbooks.

Changes

  • Banner: assets/neuroapi-cookbook.png is now a centered, full-width hero at the top of the README, followed by a centered title, tagline, and badge row (CI, Docs, Python, License), matching the OpenAI and Groq layout.
  • LICENSE: added MIT, the standard for every reference cookbook.
  • Formatting & linting: Ruff is configured in pyproject.toml (E/W/F/I/UP/B/SIM/RUF, line length 100, py39 target) and added as a dev dependency. All examples are formatted and lint-clean.
  • CI: .github/workflows/ci.yml runs ruff check, ruff format --check, and byte-compile on every push to main and every PR.
  • CONTRIBUTING: documents the uv setup and the Ruff workflow contributors should run before opening a PR.

Verification

ruff check examples/           # All checks passed!
ruff format --check examples/  # 5 files already formatted
python -m compileall examples/ # ok

🤖 Generated with Claude Code

0xspacecreated and others added 4 commits May 16, 2026 12:13
- Add banner image to the top of the README (centered hero + badges)
- Add MIT LICENSE
- Configure Ruff formatting and linting in pyproject.toml
- Add CI workflow running ruff check, ruff format --check, and byte-compile
- Document formatting/linting workflow in CONTRIBUTING.md

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@0xspacecreated 0xspacecreated self-assigned this May 16, 2026
@0xspacecreated
0xspacecreated merged commit b39423b into main May 16, 2026
1 check passed
@0xspacecreated
0xspacecreated deleted the chore/cookbook-polish branch May 16, 2026 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant