Skip to content

Commit e15de02

Browse files
pythonhubdevpythonhubdev
authored
Feat/scaffoldr (#84)
* fix: update dependabot to raise grouped PR * refactor: remove codeql for latest update * refactor: re-format few files
1 parent 3af2cd6 commit e15de02

File tree

10 files changed

+436
-498
lines changed

10 files changed

+436
-498
lines changed

‎.gemini/settings.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"contextFileName": "AGENTS.md"
2+
"contextFileName": "AGENTS.md"
33
}

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ Briefly describe the issue.
3636
- Hardware (if relevant): CPU/GPU model, RAM
3737
- Key deps (if relevant): torch, transformers, kokoro, ollama, openai, huggingface-hub
3838
- Env vars (redact secrets):
39-
- OPEN_ROUTER_API_KEY (redacted)
40-
- HUGGINGFACE_API_KEY (redacted)
41-
- WHISPER_MODEL_SIZE (e.g., base)
42-
- DEFAULT_LLM_MODEL (e.g., openchat/openchat-3.5)
43-
- DEFAULT_VOICE_ID (e.g., en_US-lessac-medium)
39+
- OPEN_ROUTER_API_KEY (redacted)
40+
- HUGGINGFACE_API_KEY (redacted)
41+
- WHISPER_MODEL_SIZE (e.g., base)
42+
- DEFAULT_LLM_MODEL (e.g., openchat/openchat-3.5)
43+
- DEFAULT_VOICE_ID (e.g., en_US-lessac-medium)
4444

4545
## Steps to Reproduce
4646

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ High-level approach and rationale. Mention alternatives considered.
7474
- Integration tests (end-to-end pipeline): scenarios
7575
- Edge cases: timeouts, retries, model unavailability, interruptions
7676
- Commands to run locally:
77-
- [ ] task test
78-
- [ ] task lint
77+
- [ ] task test
78+
- [ ] task lint
7979

8080
## Acceptance Criteria
8181

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ If yes, describe impact and migration steps:
3939
## Testing & Verification
4040

4141
- Commands run locally:
42-
- [ ] task test (pytest)
43-
- [ ] task lint (ruff/pyright/mypy)
44-
- [ ] pre-commit run --all-files (optional)
42+
- [ ] task test (pytest)
43+
- [ ] task lint (ruff/pyright/mypy)
44+
- [ ] pre-commit run --all-files (optional)
4545
- Added/updated tests: [ ] unit [ ] integration
4646
- Key scenarios and edge cases:
4747

‎.github/dependabot.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,7 @@ updates:
44
directory: "/"
55
schedule:
66
interval: "weekly"
7+
groups:
8+
- name: "all"
9+
patterns:
10+
- "*"

‎.github/workflows/codeql-analysis.yml‎

Lines changed: 0 additions & 73 deletions
This file was deleted.

‎.ruler/FASTAPI.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -150,11 +150,11 @@ app.include_router(api.router, prefix="/api")
150150
### Route Patterns
151151

152152
1. **RESTful Design**: Follow REST conventions
153-
- `GET /api/storage/files` - List resources
154-
- `POST /api/storage/upload` - Create resource
155-
- `GET /api/storage/files/{id}` - Get specific resource
156-
- `PUT /api/storage/files/{id}` - Update resource
157-
- `DELETE /api/storage/files/{id}` - Delete resource
153+
- `GET /api/storage/files` - List resources
154+
- `POST /api/storage/upload` - Create resource
155+
- `GET /api/storage/files/{id}` - Get specific resource
156+
- `PUT /api/storage/files/{id}` - Update resource
157+
- `DELETE /api/storage/files/{id}` - Delete resource
158158

159159
2. **Consistent Response Format**: All endpoints return structured responses
160160
3. **Proper Status Codes**: Use appropriate HTTP status codes
@@ -423,9 +423,9 @@ async def custom_exception_handler(request: Request, exc: CustomException):
423423
### Git Workflow
424424

425425
1. **Branch Naming**:
426-
- Features: `feature/feature-name`
427-
- Bug fixes: `fix/bug-description`
428-
- Hotfixes: `hotfix/critical-issue`
426+
- Features: `feature/feature-name`
427+
- Bug fixes: `fix/bug-description`
428+
- Hotfixes: `hotfix/critical-issue`
429429

430430
2. **Commit Messages**: Use conventional commits format
431431
```

‎CONTRIBUTING.md‎

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@
22

33
Hello Developers! 👋🏻
44

5-
Thank you for spending your valuable time to contribute to **Scaffoldr**. All PRs, contributions, reviews, and suggestions are welcome. Please follow the guidelines below to contribute to this project.
5+
Thank you for spending your valuable time to contribute to **Scaffoldr**. All PRs, contributions, reviews, and
6+
suggestions are welcome. Please follow the guidelines below to contribute to this project.
67

78
## 🐛 Creating an Issue
89

910
Please follow the issue template while creating an issue. If you are creating an issue, follow the below templates:
1011

11-
1. **For Bugs** - [Bug Template](https://github.com/pythonhubdev/scaffoldr/blob/main/.github/ISSUE_TEMPLATE/bug_report.md)
12-
2. **For Feature Requests** - [Feature Template](https://github.com/pythonhubdev/scaffoldr/blob/main/.github/ISSUE_TEMPLATE/feature_request.md)
12+
1. **For Bugs
13+
** - [Bug Template](https://github.com/pythonhubdev/scaffoldr/blob/main/.github/ISSUE_TEMPLATE/bug_report.md)
14+
2. **For Feature Requests
15+
** - [Feature Template](https://github.com/pythonhubdev/scaffoldr/blob/main/.github/ISSUE_TEMPLATE/feature_request.md)
1316

1417
You can also use the custom template to create an issue if the above templates don't match your needs.
1518

@@ -59,9 +62,9 @@ You can also use the custom template to create an issue if the above templates d
5962
```
6063

6164
2. **Make your changes**
62-
- Follow the existing code style and patterns
63-
- Add tests for new functionality
64-
- Update documentation if needed
65+
- Follow the existing code style and patterns
66+
- Add tests for new functionality
67+
- Update documentation if needed
6568

6669
3. **Run quality checks**
6770
```bash
@@ -135,14 +138,14 @@ task ds-store # Remove .DS_Store files
135138
## 🔄 Creating a Pull Request
136139

137140
1. **Ensure all checks pass**
138-
- All tests pass (`task test`)
139-
- Linting passes (`task lint`)
140-
- Pre-commit hooks pass (`task pre-commit`)
141+
- All tests pass (`task test`)
142+
- Linting passes (`task lint`)
143+
- Pre-commit hooks pass (`task pre-commit`)
141144

142145
2. **Write a clear PR description**
143-
- Describe what your PR does
144-
- Reference any related issues
145-
- Include screenshots if UI changes are involved
146+
- Describe what your PR does
147+
- Reference any related issues
148+
- Include screenshots if UI changes are involved
146149

147150
3. **Use conventional commit messages**
148151
```
@@ -165,11 +168,13 @@ task ds-store # Remove .DS_Store files
165168

166169
- **General Questions**: Open a [Discussion](https://github.com/pythonhubdev/scaffoldr/discussions)
167170
- **Bug Reports**: Create an [Issue](https://github.com/pythonhubdev/scaffoldr/issues)
168-
- **Feature Requests**: Create a [Feature Request](https://github.com/pythonhubdev/scaffoldr/issues/new?template=feature_request.md)
171+
- **Feature Requests**: Create
172+
a [Feature Request](https://github.com/pythonhubdev/scaffoldr/issues/new?template=feature_request.md)
169173

170174
## 📜 Code of Conduct
171175

172-
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
176+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in
177+
this project, you agree to abide by its terms.
173178

174179
---
175180

‎README.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
55
**Modern Python web framework project generator with production-ready architecture.**
66

7-
Scaffoldr is a CLI tool designed to help developers quickly set up and manage project structures, configurations, and boilerplate code for modern Python web frameworks. It automates the initial setup process, allowing developers to focus on writing code rather than spending time on repetitive tasks.
7+
Scaffoldr is a CLI tool designed to help developers quickly set up and manage project structures, configurations, and
8+
boilerplate code for modern Python web frameworks. It automates the initial setup process, allowing developers to focus
9+
on writing code rather than spending time on repetitive tasks.
810

911
[![Python 3.13+](https://img.shields.io/badge/python-3.13+-blue.svg)](https://www.python.org/downloads/)
1012
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -62,13 +64,13 @@ scaffoldr generate --help
6264

6365
## 🏗️ Supported Frameworks
6466

65-
| Framework | Status | Description |
66-
|-----------|--------|-------------|
67-
| **FastAPI** | ✅ Available | Modern, high-performance web framework |
68-
| **Flask** | 🚧 Coming Soon | Lightweight and flexible web framework |
69-
| **Litestar** | 🚧 Planned | High-performance ASGI web framework |
70-
| **BlackSheep** | 🚧 Planned | Fast ASGI web framework |
71-
| **Robyn** | 🚧 Planned | Rust-powered Python web framework |
67+
| Framework | Status | Description |
68+
|----------------|----------------|----------------------------------------|
69+
| **FastAPI** | ✅ Available | Modern, high-performance web framework |
70+
| **Flask** | 🚧 Coming Soon | Lightweight and flexible web framework |
71+
| **Litestar** | 🚧 Planned | High-performance ASGI web framework |
72+
| **BlackSheep** | 🚧 Planned | Fast ASGI web framework |
73+
| **Robyn** | 🚧 Planned | Rust-powered Python web framework |
7274

7375
## 📁 Generated Project Structure
7476

0 commit comments

Comments
 (0)