Skip to content

Commit 85e10b0

Browse files
authored
feat: bootstrap repository for rustarium initialization (#4)
## 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) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] Documentation update (changes to `README.md`, `SUPPORT.md`, docstrings, etc.) - [x] 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 - [x] Includes AI-assisted code completion - [x] 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`. - [x] "I certify that all code in this PR is my own, except as noted below." - [x] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guide. - [x] My code follows the established style guidelines of `rustarium`. - [x] I have performed a self-review of my own code. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have made corresponding changes to the documentation. - [x] My changes generate no new warnings or errors. - [x] I have added tests that prove my fix is effective or that my feature works. - [x] New and existing unit tests pass locally with my changes.
1 parent 8f53435 commit 85e10b0

56 files changed

Lines changed: 343 additions & 1778 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.editorconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ==============================================================================
2-
# EditorConfig for template-python
2+
# EditorConfig for rustarium
33
# https://editorconfig.org
44
#
55
# This file enforces consistent coding styles across multiple editors and IDEs.

.env.example

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
APP_ENV=development
1616
# Enable/disable debug mode (verbose logging, stack traces)
1717
APP_DEBUG=true
18-
APP_NAME="template_python"
18+
APP_NAME="rustarium"
1919
APP_VERSION="1.0.0"
2020
# Base URL for the application (useful for generating absolute links, emails)
2121
APP_URL=http://localhost:8080
@@ -42,13 +42,13 @@ CORS_ALLOWED_ORIGINS=http://localhost:3000,http://localhost:8080
4242
DB_CONNECTION=postgres
4343
DB_HOST=localhost
4444
DB_PORT=5432
45-
DB_DATABASE=template_python_dev
45+
DB_DATABASE=rustarium_dev
4646
DB_USERNAME=admin
4747
DB_PASSWORD=secret
4848
# Database schema (if applicable, e.g., public for postgres)
4949
DB_SCHEMA=public
5050
# Full connection string alternative (often used by ORMs like Prisma or SQLAlchemy)
51-
# DATABASE_URL=postgres://admin:secret@localhost:5432/template_python_dev
51+
# DATABASE_URL=postgres://admin:secret@localhost:5432/rustarium_dev
5252

5353
# ------------------------------------------------------------------------------
5454
# Cache / Key-Value Store / Message Brokers

.github/CODEOWNERS

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,46 +19,46 @@
1919
# Catches all files not matched by a more specific rule below.
2020
# This team or user is the reviewer of last resort.
2121
# -----------------------------------------------------------------------------
22-
* @{{maintainer_username}}
22+
* @markurtz
2323

2424
# -----------------------------------------------------------------------------
2525
# CI/CD & Infrastructure
2626
# Requires review from a platform/infrastructure team for any workflow changes.
2727
# -----------------------------------------------------------------------------
28-
.github/ @{{maintainer_username}}
29-
.github/workflows/ @{{maintainer_username}}
28+
.github/ @markurtz
29+
.github/workflows/ @markurtz
3030

3131
# -----------------------------------------------------------------------------
3232
# Documentation
3333
# Route docs changes to the team responsible for content quality.
3434
# -----------------------------------------------------------------------------
35-
docs/ @{{maintainer_username}}
36-
*.md @{{maintainer_username}}
37-
mkdocs.yml @{{maintainer_username}}
35+
docs/ @markurtz
36+
*.md @markurtz
37+
mkdocs.yml @markurtz
3838

3939
# -----------------------------------------------------------------------------
4040
# Security-Sensitive Files
4141
# Any change to security policy, secrets config, or dependencies must be
4242
# reviewed by the security team.
4343
# -----------------------------------------------------------------------------
44-
SECURITY.md @{{maintainer_username}}
45-
.github/dependabot.yml @{{maintainer_username}}
46-
.pre-commit-config.yaml @{{maintainer_username}}
44+
SECURITY.md @markurtz
45+
.github/dependabot.yml @markurtz
46+
.pre-commit-config.yaml @markurtz
4747

4848
# -----------------------------------------------------------------------------
4949
# Core Source Code
5050
# Replace with the path to your primary package directory.
5151
# -----------------------------------------------------------------------------
52-
src/ @{{maintainer_username}}
52+
src/ @markurtz
5353

5454
# -----------------------------------------------------------------------------
5555
# Tests
5656
# Requires review from someone responsible for test quality and coverage.
5757
# -----------------------------------------------------------------------------
58-
tests/ @{{maintainer_username}}
58+
tests/ @markurtz
5959

6060
# -----------------------------------------------------------------------------
6161
# Container & Deployment
6262
# -----------------------------------------------------------------------------
63-
Dockerfile @{{maintainer_username}}
64-
docker-compose.yml @{{maintainer_username}}
63+
Dockerfile @markurtz
64+
docker-compose.yml @markurtz

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
---
22
name: 🐛 Bug Report
3-
description: Create a report to help us improve template-python
3+
description: Create a report to help us improve rustarium
44
labels:
55
- "bug"
66
- "triage"
77
body:
88
- type: markdown
99
attributes:
1010
value: |
11-
Thanks for taking the time to report a bug to `template-python`!
11+
Thanks for taking the time to report a bug to `rustarium`!
1212
> [!IMPORTANT]
1313
> If you have found a **security vulnerability**, please refer to our [Security Policy](../SECURITY.md) and do not open a public issue.
14-
For general help and Q&A, please use [GitHub Discussions](https://github.com/markurtz/template-python/discussions) instead.
14+
For general help and Q&A, please use [GitHub Discussions](https://github.com/markurtz/rustarium/discussions) instead.
1515
- type: checkboxes
1616
id: checks
1717
attributes:
1818
label: Search before asking
1919
description: Please confirm that you have checked the following before submitting your
2020
bug report.
2121
options:
22-
- label: I have searched the [existing issues](https://github.com/markurtz/template-python/issues)
22+
- label: I have searched the [existing issues](https://github.com/markurtz/rustarium/issues)
2323
and could not find a similar bug.
2424
required: true
25-
- label: I have read the [Official Documentation](https://markurtz.github.io/template-python).
25+
- label: I have read the [Official Documentation](https://markurtz.github.io/rustarium).
2626
required: true
2727
- type: textarea
2828
id: description
@@ -60,7 +60,7 @@ body:
6060
value: |
6161
- OS (e.g., Linux, macOS, Windows):
6262
- Language Version (e.g., Python 3.10):
63-
- `template-python` Version:
63+
- `rustarium` Version:
6464
- Other relevant dependency versions:
6565
validations:
6666
required: true

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
name: Feature Request
3-
description: Suggest an idea for template-python
3+
description: Suggest an idea for rustarium
44
labels:
55
- "enhancement"
66
body:
77
- type: markdown
88
attributes:
99
value: |
10-
Thanks for taking the time to suggest a feature for template-python!
11-
Before submitting, please ensure you have searched our existing [Issues](https://github.com/markurtz/template-python/issues) and [Discussions](https://github.com/markurtz/template-python/discussions) to see if this feature has already been requested.
10+
Thanks for taking the time to suggest a feature for rustarium!
11+
Before submitting, please ensure you have searched our existing [Issues](https://github.com/markurtz/rustarium/issues) and [Discussions](https://github.com/markurtz/rustarium/discussions) to see if this feature has already been requested.
1212
- type: textarea
1313
id: problem
1414
attributes:

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
Thanks for contributing to template-python!
2+
Thanks for contributing to rustarium!
33
Please review the [Contributing Guidelines](../CONTRIBUTING.md) before submitting your PR.
44
-->
55

@@ -57,11 +57,11 @@ please add screenshots, terminal output, or recordings to demonstrate the change
5757
## Checklist
5858

5959
> [!IMPORTANT]
60-
> 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`.
60+
> 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 `rustarium`.
6161
6262
- [ ] "I certify that all code in this PR is my own, except as noted below."
6363
- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guide.
64-
- [ ] My code follows the established style guidelines of `template-python`.
64+
- [ ] My code follows the established style guidelines of `rustarium`.
6565
- [ ] I have performed a self-review of my own code.
6666
- [ ] I have commented my code, particularly in hard-to-understand areas.
6767
- [ ] I have made corresponding changes to the documentation.

.github/dependabot.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ updates:
3333
commit-message:
3434
prefix: "chore(actions)"
3535
reviewers:
36-
- "{{maintainer_username}}"
36+
- "markurtz"
3737
assignees:
38-
- "{{maintainer_username}}"
38+
- "markurtz"
3939
open-pull-requests-limit: 5
4040

4141
# ── Python (pip) ────────────────────────────────────────────────────────────
@@ -56,9 +56,9 @@ updates:
5656
commit-message:
5757
prefix: "chore(deps)"
5858
reviewers:
59-
- "{{maintainer_username}}"
59+
- "markurtz"
6060
assignees:
61-
- "{{maintainer_username}}"
61+
- "markurtz"
6262
open-pull-requests-limit: 5
6363

6464
# ── Docker ───────────────────────────────────────────────────────────────────
@@ -75,7 +75,7 @@ updates:
7575
commit-message:
7676
prefix: "chore(docker)"
7777
reviewers:
78-
- "{{maintainer_username}}"
78+
- "markurtz"
7979
assignees:
80-
- "{{maintainer_username}}"
80+
- "markurtz"
8181
open-pull-requests-limit: 3

.github/workflows/nightly.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ jobs:
123123
uses: actions/attest-build-provenance@c074443f1aee8d4aeeae555aebba3282517141b2 # v1.5.1
124124
with:
125125
subject-path: dist/*
126-
# - name: Publish to PyPI
127-
# uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14
128-
# with:
129-
# packages-dir: dist/
126+
- name: Publish to PyPI
127+
uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14
128+
with:
129+
packages-dir: dist/

.github/workflows/release.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ jobs:
8383
uses: actions/attest-build-provenance@c074443f1aee8d4aeeae555aebba3282517141b2 # v1.5.1
8484
with:
8585
subject-path: dist/*
86-
# - name: Publish to PyPI
87-
# uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14
88-
# with:
89-
# packages-dir: dist/
86+
- name: Publish to PyPI
87+
uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14
88+
with:
89+
packages-dir: dist/
9090
- name: Create GitHub Release
9191
if: ${{ github.ref_type == 'tag' }}
9292
uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191 # v2.0.8

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ nosetests.xml
161161
# ==============================================================================
162162

163163
# Python
164-
src/template_python/version.py
164+
src/rustarium/version.py
165165
__pycache__/
166166
*.py[cod]
167167
*$py.class

0 commit comments

Comments
 (0)