feat: bootstrap repository for rustarium initialization#4
Merged
Conversation
Contributor
CI Development Pipeline Status✅ Pipeline: Completed successfully. View Run Details |
There was a problem hiding this comment.
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_python→src/rustariumand 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.pyand its e2e/unit tests, uncommented PyPI publishing inrelease.ymlandnightly.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.
Contributor
CI Development Pipeline Status✅ Pipeline: Completed successfully. View Run Details |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR finalizes the repository bootstrapping process by applying the
scripts/bootstrap.pyscript to customize the generictemplate-pythonstructure into therustariumproject. It establishes the foundational package layout for the upcoming 0.0.1 release.Key changes include:
template_pythontorustarium.rustariumproject metadata across configuration files (pyproject.toml,mkdocs.yml,.github/*, etc.).README.md,docs/,CONTRIBUTING.md, etc.) to reflect the new project identity and ownership.scripts/bootstrap.pyutility and its associated tests (tests/e2e/test_bootstrap.py,tests/unit/test_bootstrap.py), as they are no longer required post-customization.rustarium.Type of Change
README.md,SUPPORT.md, docstrings, etc.)Test Plan
rustariummodule usinghatch run test:all.hatch build) recognizing the newrustariumpackage structure.hatch run lint:check/pre-commit).Related Issues
Screenshots / Visuals (if applicable)
(No visual UI changes introduced in this PR.)
Use of AI
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.rustarium.