Skip to content

feat: bootstrap repository for rustarium initialization#4

Merged
markurtz merged 2 commits into
mainfrom
feature/bootstrap
May 14, 2026
Merged

feat: bootstrap repository for rustarium initialization#4
markurtz merged 2 commits into
mainfrom
feature/bootstrap

Conversation

@markurtz
Copy link
Copy Markdown
Owner

Description

This PR finalizes the repository bootstrapping process by applying the scripts/bootstrap.py script to customize the generic template-python structure into the rustarium project. It establishes the foundational package layout for the upcoming 0.0.1 release.

Key changes include:

  • Renamed the primary source module from template_python to rustarium.
  • Replaced all template placeholders with rustarium project metadata across configuration files (pyproject.toml, mkdocs.yml, .github/*, etc.).
  • Updated all documentation (README.md, docs/, CONTRIBUTING.md, etc.) to reflect the new project identity and ownership.
  • Removed the one-time scripts/bootstrap.py utility and its associated tests (tests/e2e/test_bootstrap.py, tests/unit/test_bootstrap.py), as they are no longer required post-customization.
  • Re-pointed internal imports, logging namespaces, and test references to target rustarium.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (changes to README.md, SUPPORT.md, docstrings, etc.)
  • Maintenance/Refactoring (non-breaking change that improves code structure or quality)

Test Plan

  • Verified all unit and integration tests execute successfully against the newly renamed rustarium module using hatch run test:all.
  • Validated correct functionality of the build pipeline (hatch build) recognizing the new rustarium package structure.
  • Ensured formatting and linting pass cleanly over the new structure (hatch run lint:check / pre-commit).

Related Issues

  • N/A

Screenshots / Visuals (if applicable)

(No visual UI changes introduced in this PR.)

Use of AI

  • Includes AI-assisted code completion
  • Includes code generated by an AI application
  • Includes AI-generated tests

Checklist

Important

Please review and complete this checklist before submitting your PR. This helps our maintainers process your contribution faster and ensures it meets the quality standards of template-python.

  • "I certify that all code in this PR is my own, except as noted below."
  • I have read the CONTRIBUTING.md guide.
  • My code follows the established style guidelines of rustarium.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings or errors.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

@github-actions
Copy link
Copy Markdown
Contributor

CI Development Pipeline Status

Pipeline: Completed successfully. View Run Details

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Applies the template's bootstrap.py script to convert the generic template-python scaffolding into the rustarium project: renames the source package, updates project metadata across configuration and documentation, removes the now-unneeded bootstrap script and its tests, and enables PyPI publishing.

Changes:

  • Renamed src/template_pythonsrc/rustarium and re-pointed every import, logger namespace, env prefix (TEMPLATE_PYTHON__RUSTARIUM__), and CLI entrypoint accordingly.
  • Updated all repo-level docs (README, SUPPORT, SECURITY, CONTRIBUTING, docs/**, llms*.txt, etc.) and config files (pyproject.toml, mkdocs.yml, Dockerfile, docker-compose.yml, .env.example, dependabot/CODEOWNERS/issue templates) with the new project identity.
  • Removed scripts/bootstrap.py and its e2e/unit tests, uncommented PyPI publishing in release.yml and nightly.yml.

Reviewed changes

Copilot reviewed 52 out of 56 changed files in this pull request and generated 10 comments.

Show a summary per file
File Description
uv.lock, pyproject.toml Package rename to rustarium, new description, updated URLs, wheel/mypy/ruff/isort paths.
src/rustarium/*.py Docstrings, env prefixes, logger namespace, python -m example all switched from template_python to rustarium.
tests/unit/*, tests/integration/*, tests/e2e/test_main.py, tests/README.md Imports and env-var/CLI expectations re-targeted at rustarium.
tests/unit/test_bootstrap.py, tests/e2e/test_bootstrap.py, scripts/bootstrap.py Bootstrap script and its tests deleted.
README.md, SUPPORT.md, SECURITY.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, DEVELOPING.md, AGENTS.md, NOTICE, CITATION.cff, llms.txt, llms-full.txt Project name, URLs, copyright year (2026), tagline updates.
docs/** Project name and links updated throughout the MkDocs site.
mkdocs.yml Site/repo metadata updated; org_email blanked.
Dockerfile, docker-compose.yml, .env.example, .editorconfig, .gitignore Renamed source path / app name / DB name references.
examples/** Example README and main.py re-pointed at rustarium.
.github/CODEOWNERS, .github/dependabot.yml {{maintainer_username}} replaced (incorrectly, double @ / leading @).
.github/ISSUE_TEMPLATE/*, .github/PULL_REQUEST_TEMPLATE.md Repo name updates.
.github/workflows/release.yml, .github/workflows/nightly.yml "Publish to PyPI" step enabled.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/CODEOWNERS Outdated
Comment thread .github/dependabot.yml Outdated
Comment thread CODE_OF_CONDUCT.md
Comment thread CITATION.cff Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread llms.txt
Comment thread llms-full.txt
Comment thread README.md Outdated
Comment thread .github/workflows/nightly.yml
@github-actions
Copy link
Copy Markdown
Contributor

CI Development Pipeline Status

Pipeline: Completed successfully. View Run Details

@markurtz markurtz merged commit 85e10b0 into main May 14, 2026
14 checks passed
@markurtz markurtz deleted the feature/bootstrap branch May 14, 2026 22: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.

2 participants