projectstarter-cli 0.1.0__tar.gz → 0.1.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/PKG-INFO +28 -28
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/README.md +27 -27
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter/cli.py +3 -3
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter_cli.egg-info/PKG-INFO +28 -28
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/pyproject.toml +1 -1
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/LICENSE +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter/__init__.py +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter/doctor.py +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter/generator.py +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter/registry.py +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter/utils.py +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter_cli.egg-info/SOURCES.txt +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter_cli.egg-info/dependency_links.txt +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter_cli.egg-info/entry_points.txt +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter_cli.egg-info/top_level.txt +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/setup.cfg +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/tests/test_cli.py +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/tests/test_generator.py +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/tests/test_registry.py +0 -0
- {projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/tests/test_utils.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: projectstarter-cli
|
|
3
|
-
Version: 0.1.
|
|
3
|
+
Version: 0.1.1
|
|
4
4
|
Summary: A Python CLI tool for quickly generating Python, Django, Flask, and FastAPI projects
|
|
5
5
|
Author-email: Mohamed Ali Ismail Jami <mohamedali32947@gmail.com>
|
|
6
6
|
License-Expression: MIT
|
|
@@ -19,9 +19,9 @@ Description-Content-Type: text/markdown
|
|
|
19
19
|
License-File: LICENSE
|
|
20
20
|
Dynamic: license-file
|
|
21
21
|
|
|
22
|
-
#
|
|
22
|
+
# projectstarter-cli 🚀
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
projectstarter-cli is a Python CLI tool created by **Mohamed Ali Ismail Jami** for quickly creating ready-to-use project structures.
|
|
25
25
|
|
|
26
26
|
It helps developers avoid manually creating folders, files, virtual environments, installing framework dependencies, and preparing basic project documentation.
|
|
27
27
|
|
|
@@ -39,7 +39,7 @@ It helps developers avoid manually creating folders, files, virtual environments
|
|
|
39
39
|
- 📝 Automatically generate a README for generated projects
|
|
40
40
|
- 📋 List supported project types
|
|
41
41
|
- ℹ️ Show information about each project type
|
|
42
|
-
- 🩺 Check the
|
|
42
|
+
- 🩺 Check the projectstarter-cli installation with `doctor`
|
|
43
43
|
- 🧪 Includes automated tests
|
|
44
44
|
|
|
45
45
|
---
|
|
@@ -59,10 +59,10 @@ It helps developers avoid manually creating folders, files, virtual environments
|
|
|
59
59
|
|
|
60
60
|
# 📦 Installation
|
|
61
61
|
|
|
62
|
-
Install
|
|
62
|
+
Install projectstarter-cli from PyPI:
|
|
63
63
|
|
|
64
64
|
```bash
|
|
65
|
-
pip install projectstarter
|
|
65
|
+
pip install projectstarter-cli
|
|
66
66
|
```
|
|
67
67
|
|
|
68
68
|
Check that it is installed:
|
|
@@ -89,7 +89,7 @@ Run:
|
|
|
89
89
|
projectstarter create
|
|
90
90
|
```
|
|
91
91
|
|
|
92
|
-
|
|
92
|
+
projectstarter-cli will show the available project types:
|
|
93
93
|
|
|
94
94
|
```text
|
|
95
95
|
Choose a project type:
|
|
@@ -109,7 +109,7 @@ Enter your choice: 2
|
|
|
109
109
|
Enter project name: myproject
|
|
110
110
|
```
|
|
111
111
|
|
|
112
|
-
|
|
112
|
+
projectstarter-cli will create the project automatically.
|
|
113
113
|
|
|
114
114
|
---
|
|
115
115
|
|
|
@@ -156,7 +156,7 @@ Create a Django project:
|
|
|
156
156
|
projectstarter create django myproject
|
|
157
157
|
```
|
|
158
158
|
|
|
159
|
-
|
|
159
|
+
projectstarter-cli automatically:
|
|
160
160
|
|
|
161
161
|
1. Creates the project directory.
|
|
162
162
|
2. Creates `.venv`.
|
|
@@ -222,7 +222,7 @@ Create a Flask project:
|
|
|
222
222
|
projectstarter create flask myproject
|
|
223
223
|
```
|
|
224
224
|
|
|
225
|
-
|
|
225
|
+
projectstarter-cli automatically:
|
|
226
226
|
|
|
227
227
|
1. Creates the project directory.
|
|
228
228
|
2. Creates `.venv`.
|
|
@@ -288,7 +288,7 @@ Create a FastAPI project:
|
|
|
288
288
|
projectstarter create fastapi myproject
|
|
289
289
|
```
|
|
290
290
|
|
|
291
|
-
|
|
291
|
+
projectstarter-cli automatically:
|
|
292
292
|
|
|
293
293
|
1. Creates the project directory.
|
|
294
294
|
2. Creates `.venv`.
|
|
@@ -406,7 +406,7 @@ projectstarter info fastapi
|
|
|
406
406
|
|
|
407
407
|
# 🩺 Doctor
|
|
408
408
|
|
|
409
|
-
|
|
409
|
+
projectstarter-cli includes a built-in diagnostic command:
|
|
410
410
|
|
|
411
411
|
```bash
|
|
412
412
|
projectstarter doctor
|
|
@@ -422,7 +422,7 @@ It checks:
|
|
|
422
422
|
Example:
|
|
423
423
|
|
|
424
424
|
```text
|
|
425
|
-
|
|
425
|
+
projectstarter-cli Doctor
|
|
426
426
|
──────────────────────────────
|
|
427
427
|
✓ Python
|
|
428
428
|
Version: 3.x.x
|
|
@@ -440,9 +440,9 @@ Everything looks good! ✓
|
|
|
440
440
|
|
|
441
441
|
---
|
|
442
442
|
|
|
443
|
-
# 🧪 Testing
|
|
443
|
+
# 🧪 Testing projectstarter-cli
|
|
444
444
|
|
|
445
|
-
|
|
445
|
+
projectstarter-cli uses `pytest` for automated testing.
|
|
446
446
|
|
|
447
447
|
Install pytest for development:
|
|
448
448
|
|
|
@@ -471,9 +471,9 @@ The test suite covers:
|
|
|
471
471
|
|
|
472
472
|
---
|
|
473
473
|
|
|
474
|
-
# 🏗️
|
|
474
|
+
# 🏗️ projectstarter-cli Development Structure
|
|
475
475
|
|
|
476
|
-
The
|
|
476
|
+
The projectstarter-cli source code is organized as follows:
|
|
477
477
|
|
|
478
478
|
```text
|
|
479
479
|
projectstarter/
|
|
@@ -545,7 +545,7 @@ Contains the automated test suite.
|
|
|
545
545
|
|
|
546
546
|
# ➕ Adding a New Generator
|
|
547
547
|
|
|
548
|
-
|
|
548
|
+
projectstarter-cli is designed so that new project types can be added to the generator system.
|
|
549
549
|
|
|
550
550
|
A new generator generally needs:
|
|
551
551
|
|
|
@@ -562,7 +562,7 @@ This keeps the CLI organized and makes the tool easier to extend.
|
|
|
562
562
|
|
|
563
563
|
# 🔐 Project Name Rules
|
|
564
564
|
|
|
565
|
-
|
|
565
|
+
projectstarter-cli validates project names before creating projects.
|
|
566
566
|
|
|
567
567
|
Valid examples:
|
|
568
568
|
|
|
@@ -586,9 +586,9 @@ Project names must use letters, numbers, and underscores and must not start with
|
|
|
586
586
|
|
|
587
587
|
# 👨💻 Author
|
|
588
588
|
|
|
589
|
-
**Mohamed Ali**
|
|
589
|
+
**Mohamed Ali Ismail Jami**
|
|
590
590
|
|
|
591
|
-
|
|
591
|
+
projectstarter-cli was created and is maintained by Mohamed Ali Ismail Jami.
|
|
592
592
|
|
|
593
593
|
## 📞 Contact
|
|
594
594
|
|
|
@@ -598,9 +598,9 @@ For questions, suggestions, bug reports, or contributions, contact the project m
|
|
|
598
598
|
- Project Repository: https://github.com/hamada-cool/projectstarter
|
|
599
599
|
- Bug Reports / Issues: https://github.com/hamada-cool/projectstarter/issues
|
|
600
600
|
- Email: `mohamedali32947@gmail.com`
|
|
601
|
-
- Phone / WhatsApp: `+918341391506`
|
|
601
|
+
- Phone / WhatsApp: `+918341391506` and `+249919532947`
|
|
602
602
|
|
|
603
|
-
You can also open a GitHub Issue if you find a bug or have an idea for improving
|
|
603
|
+
You can also open a GitHub Issue if you find a bug or have an idea for improving projectstarter-cli.
|
|
604
604
|
|
|
605
605
|
---
|
|
606
606
|
|
|
@@ -626,7 +626,7 @@ python -m pytest
|
|
|
626
626
|
|
|
627
627
|
# 📄 License
|
|
628
628
|
|
|
629
|
-
|
|
629
|
+
projectstarter-cli is licensed under the **MIT License**.
|
|
630
630
|
|
|
631
631
|
See the `LICENSE` file for the complete license text.
|
|
632
632
|
|
|
@@ -634,7 +634,7 @@ See the `LICENSE` file for the complete license text.
|
|
|
634
634
|
|
|
635
635
|
# 🎯 Project Status
|
|
636
636
|
|
|
637
|
-
|
|
637
|
+
projectstarter-cli currently supports:
|
|
638
638
|
|
|
639
639
|
- Python
|
|
640
640
|
- Django
|
|
@@ -647,7 +647,7 @@ The project is under active development, and more generators and features may be
|
|
|
647
647
|
|
|
648
648
|
## ⭐ Support the Project
|
|
649
649
|
|
|
650
|
-
If you find
|
|
650
|
+
If you find projectstarter-cli useful, you can support the project by:
|
|
651
651
|
|
|
652
652
|
- ⭐ Starring the GitHub repository
|
|
653
653
|
- 🐛 Reporting bugs
|
|
@@ -657,6 +657,6 @@ If you find ProjectStarter useful, you can support the project by:
|
|
|
657
657
|
|
|
658
658
|
---
|
|
659
659
|
|
|
660
|
-
**
|
|
660
|
+
**projectstarter-cli — Start your next Python project faster. 🚀**
|
|
661
661
|
|
|
662
|
-
Created by **Mohamed Ali**.
|
|
662
|
+
Created by **Mohamed Ali Ismail Jami**.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# projectstarter-cli 🚀
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
projectstarter-cli is a Python CLI tool created by **Mohamed Ali Ismail Jami** for quickly creating ready-to-use project structures.
|
|
4
4
|
|
|
5
5
|
It helps developers avoid manually creating folders, files, virtual environments, installing framework dependencies, and preparing basic project documentation.
|
|
6
6
|
|
|
@@ -18,7 +18,7 @@ It helps developers avoid manually creating folders, files, virtual environments
|
|
|
18
18
|
- 📝 Automatically generate a README for generated projects
|
|
19
19
|
- 📋 List supported project types
|
|
20
20
|
- ℹ️ Show information about each project type
|
|
21
|
-
- 🩺 Check the
|
|
21
|
+
- 🩺 Check the projectstarter-cli installation with `doctor`
|
|
22
22
|
- 🧪 Includes automated tests
|
|
23
23
|
|
|
24
24
|
---
|
|
@@ -38,10 +38,10 @@ It helps developers avoid manually creating folders, files, virtual environments
|
|
|
38
38
|
|
|
39
39
|
# 📦 Installation
|
|
40
40
|
|
|
41
|
-
Install
|
|
41
|
+
Install projectstarter-cli from PyPI:
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
|
-
pip install projectstarter
|
|
44
|
+
pip install projectstarter-cli
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
Check that it is installed:
|
|
@@ -68,7 +68,7 @@ Run:
|
|
|
68
68
|
projectstarter create
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
projectstarter-cli will show the available project types:
|
|
72
72
|
|
|
73
73
|
```text
|
|
74
74
|
Choose a project type:
|
|
@@ -88,7 +88,7 @@ Enter your choice: 2
|
|
|
88
88
|
Enter project name: myproject
|
|
89
89
|
```
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
projectstarter-cli will create the project automatically.
|
|
92
92
|
|
|
93
93
|
---
|
|
94
94
|
|
|
@@ -135,7 +135,7 @@ Create a Django project:
|
|
|
135
135
|
projectstarter create django myproject
|
|
136
136
|
```
|
|
137
137
|
|
|
138
|
-
|
|
138
|
+
projectstarter-cli automatically:
|
|
139
139
|
|
|
140
140
|
1. Creates the project directory.
|
|
141
141
|
2. Creates `.venv`.
|
|
@@ -201,7 +201,7 @@ Create a Flask project:
|
|
|
201
201
|
projectstarter create flask myproject
|
|
202
202
|
```
|
|
203
203
|
|
|
204
|
-
|
|
204
|
+
projectstarter-cli automatically:
|
|
205
205
|
|
|
206
206
|
1. Creates the project directory.
|
|
207
207
|
2. Creates `.venv`.
|
|
@@ -267,7 +267,7 @@ Create a FastAPI project:
|
|
|
267
267
|
projectstarter create fastapi myproject
|
|
268
268
|
```
|
|
269
269
|
|
|
270
|
-
|
|
270
|
+
projectstarter-cli automatically:
|
|
271
271
|
|
|
272
272
|
1. Creates the project directory.
|
|
273
273
|
2. Creates `.venv`.
|
|
@@ -385,7 +385,7 @@ projectstarter info fastapi
|
|
|
385
385
|
|
|
386
386
|
# 🩺 Doctor
|
|
387
387
|
|
|
388
|
-
|
|
388
|
+
projectstarter-cli includes a built-in diagnostic command:
|
|
389
389
|
|
|
390
390
|
```bash
|
|
391
391
|
projectstarter doctor
|
|
@@ -401,7 +401,7 @@ It checks:
|
|
|
401
401
|
Example:
|
|
402
402
|
|
|
403
403
|
```text
|
|
404
|
-
|
|
404
|
+
projectstarter-cli Doctor
|
|
405
405
|
──────────────────────────────
|
|
406
406
|
✓ Python
|
|
407
407
|
Version: 3.x.x
|
|
@@ -419,9 +419,9 @@ Everything looks good! ✓
|
|
|
419
419
|
|
|
420
420
|
---
|
|
421
421
|
|
|
422
|
-
# 🧪 Testing
|
|
422
|
+
# 🧪 Testing projectstarter-cli
|
|
423
423
|
|
|
424
|
-
|
|
424
|
+
projectstarter-cli uses `pytest` for automated testing.
|
|
425
425
|
|
|
426
426
|
Install pytest for development:
|
|
427
427
|
|
|
@@ -450,9 +450,9 @@ The test suite covers:
|
|
|
450
450
|
|
|
451
451
|
---
|
|
452
452
|
|
|
453
|
-
# 🏗️
|
|
453
|
+
# 🏗️ projectstarter-cli Development Structure
|
|
454
454
|
|
|
455
|
-
The
|
|
455
|
+
The projectstarter-cli source code is organized as follows:
|
|
456
456
|
|
|
457
457
|
```text
|
|
458
458
|
projectstarter/
|
|
@@ -524,7 +524,7 @@ Contains the automated test suite.
|
|
|
524
524
|
|
|
525
525
|
# ➕ Adding a New Generator
|
|
526
526
|
|
|
527
|
-
|
|
527
|
+
projectstarter-cli is designed so that new project types can be added to the generator system.
|
|
528
528
|
|
|
529
529
|
A new generator generally needs:
|
|
530
530
|
|
|
@@ -541,7 +541,7 @@ This keeps the CLI organized and makes the tool easier to extend.
|
|
|
541
541
|
|
|
542
542
|
# 🔐 Project Name Rules
|
|
543
543
|
|
|
544
|
-
|
|
544
|
+
projectstarter-cli validates project names before creating projects.
|
|
545
545
|
|
|
546
546
|
Valid examples:
|
|
547
547
|
|
|
@@ -565,9 +565,9 @@ Project names must use letters, numbers, and underscores and must not start with
|
|
|
565
565
|
|
|
566
566
|
# 👨💻 Author
|
|
567
567
|
|
|
568
|
-
**Mohamed Ali**
|
|
568
|
+
**Mohamed Ali Ismail Jami**
|
|
569
569
|
|
|
570
|
-
|
|
570
|
+
projectstarter-cli was created and is maintained by Mohamed Ali Ismail Jami.
|
|
571
571
|
|
|
572
572
|
## 📞 Contact
|
|
573
573
|
|
|
@@ -577,9 +577,9 @@ For questions, suggestions, bug reports, or contributions, contact the project m
|
|
|
577
577
|
- Project Repository: https://github.com/hamada-cool/projectstarter
|
|
578
578
|
- Bug Reports / Issues: https://github.com/hamada-cool/projectstarter/issues
|
|
579
579
|
- Email: `mohamedali32947@gmail.com`
|
|
580
|
-
- Phone / WhatsApp: `+918341391506`
|
|
580
|
+
- Phone / WhatsApp: `+918341391506` and `+249919532947`
|
|
581
581
|
|
|
582
|
-
You can also open a GitHub Issue if you find a bug or have an idea for improving
|
|
582
|
+
You can also open a GitHub Issue if you find a bug or have an idea for improving projectstarter-cli.
|
|
583
583
|
|
|
584
584
|
---
|
|
585
585
|
|
|
@@ -605,7 +605,7 @@ python -m pytest
|
|
|
605
605
|
|
|
606
606
|
# 📄 License
|
|
607
607
|
|
|
608
|
-
|
|
608
|
+
projectstarter-cli is licensed under the **MIT License**.
|
|
609
609
|
|
|
610
610
|
See the `LICENSE` file for the complete license text.
|
|
611
611
|
|
|
@@ -613,7 +613,7 @@ See the `LICENSE` file for the complete license text.
|
|
|
613
613
|
|
|
614
614
|
# 🎯 Project Status
|
|
615
615
|
|
|
616
|
-
|
|
616
|
+
projectstarter-cli currently supports:
|
|
617
617
|
|
|
618
618
|
- Python
|
|
619
619
|
- Django
|
|
@@ -626,7 +626,7 @@ The project is under active development, and more generators and features may be
|
|
|
626
626
|
|
|
627
627
|
## ⭐ Support the Project
|
|
628
628
|
|
|
629
|
-
If you find
|
|
629
|
+
If you find projectstarter-cli useful, you can support the project by:
|
|
630
630
|
|
|
631
631
|
- ⭐ Starring the GitHub repository
|
|
632
632
|
- 🐛 Reporting bugs
|
|
@@ -636,6 +636,6 @@ If you find ProjectStarter useful, you can support the project by:
|
|
|
636
636
|
|
|
637
637
|
---
|
|
638
638
|
|
|
639
|
-
**
|
|
639
|
+
**projectstarter-cli — Start your next Python project faster. 🚀**
|
|
640
640
|
|
|
641
|
-
Created by **Mohamed Ali**.
|
|
641
|
+
Created by **Mohamed Ali Ismail Jami**.
|
|
@@ -6,13 +6,13 @@ from .doctor import run_doctor
|
|
|
6
6
|
|
|
7
7
|
def main():
|
|
8
8
|
parser = argparse.ArgumentParser(
|
|
9
|
-
description="ProjectStarter - Create projects quickly"
|
|
9
|
+
description="ProjectStarter-cli - Create projects quickly"
|
|
10
10
|
)
|
|
11
11
|
|
|
12
12
|
parser.add_argument(
|
|
13
13
|
"--version",
|
|
14
14
|
action="version",
|
|
15
|
-
version="ProjectStarter 0.1.
|
|
15
|
+
version="ProjectStarter-cli 0.1.1"
|
|
16
16
|
)
|
|
17
17
|
|
|
18
18
|
subparsers = parser.add_subparsers(
|
|
@@ -53,7 +53,7 @@ def main():
|
|
|
53
53
|
# doctor command
|
|
54
54
|
subparsers.add_parser(
|
|
55
55
|
"doctor",
|
|
56
|
-
help="Check ProjectStarter installation"
|
|
56
|
+
help="Check ProjectStarter-cli installation"
|
|
57
57
|
)
|
|
58
58
|
|
|
59
59
|
info_parser.add_argument(
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: projectstarter-cli
|
|
3
|
-
Version: 0.1.
|
|
3
|
+
Version: 0.1.1
|
|
4
4
|
Summary: A Python CLI tool for quickly generating Python, Django, Flask, and FastAPI projects
|
|
5
5
|
Author-email: Mohamed Ali Ismail Jami <mohamedali32947@gmail.com>
|
|
6
6
|
License-Expression: MIT
|
|
@@ -19,9 +19,9 @@ Description-Content-Type: text/markdown
|
|
|
19
19
|
License-File: LICENSE
|
|
20
20
|
Dynamic: license-file
|
|
21
21
|
|
|
22
|
-
#
|
|
22
|
+
# projectstarter-cli 🚀
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
projectstarter-cli is a Python CLI tool created by **Mohamed Ali Ismail Jami** for quickly creating ready-to-use project structures.
|
|
25
25
|
|
|
26
26
|
It helps developers avoid manually creating folders, files, virtual environments, installing framework dependencies, and preparing basic project documentation.
|
|
27
27
|
|
|
@@ -39,7 +39,7 @@ It helps developers avoid manually creating folders, files, virtual environments
|
|
|
39
39
|
- 📝 Automatically generate a README for generated projects
|
|
40
40
|
- 📋 List supported project types
|
|
41
41
|
- ℹ️ Show information about each project type
|
|
42
|
-
- 🩺 Check the
|
|
42
|
+
- 🩺 Check the projectstarter-cli installation with `doctor`
|
|
43
43
|
- 🧪 Includes automated tests
|
|
44
44
|
|
|
45
45
|
---
|
|
@@ -59,10 +59,10 @@ It helps developers avoid manually creating folders, files, virtual environments
|
|
|
59
59
|
|
|
60
60
|
# 📦 Installation
|
|
61
61
|
|
|
62
|
-
Install
|
|
62
|
+
Install projectstarter-cli from PyPI:
|
|
63
63
|
|
|
64
64
|
```bash
|
|
65
|
-
pip install projectstarter
|
|
65
|
+
pip install projectstarter-cli
|
|
66
66
|
```
|
|
67
67
|
|
|
68
68
|
Check that it is installed:
|
|
@@ -89,7 +89,7 @@ Run:
|
|
|
89
89
|
projectstarter create
|
|
90
90
|
```
|
|
91
91
|
|
|
92
|
-
|
|
92
|
+
projectstarter-cli will show the available project types:
|
|
93
93
|
|
|
94
94
|
```text
|
|
95
95
|
Choose a project type:
|
|
@@ -109,7 +109,7 @@ Enter your choice: 2
|
|
|
109
109
|
Enter project name: myproject
|
|
110
110
|
```
|
|
111
111
|
|
|
112
|
-
|
|
112
|
+
projectstarter-cli will create the project automatically.
|
|
113
113
|
|
|
114
114
|
---
|
|
115
115
|
|
|
@@ -156,7 +156,7 @@ Create a Django project:
|
|
|
156
156
|
projectstarter create django myproject
|
|
157
157
|
```
|
|
158
158
|
|
|
159
|
-
|
|
159
|
+
projectstarter-cli automatically:
|
|
160
160
|
|
|
161
161
|
1. Creates the project directory.
|
|
162
162
|
2. Creates `.venv`.
|
|
@@ -222,7 +222,7 @@ Create a Flask project:
|
|
|
222
222
|
projectstarter create flask myproject
|
|
223
223
|
```
|
|
224
224
|
|
|
225
|
-
|
|
225
|
+
projectstarter-cli automatically:
|
|
226
226
|
|
|
227
227
|
1. Creates the project directory.
|
|
228
228
|
2. Creates `.venv`.
|
|
@@ -288,7 +288,7 @@ Create a FastAPI project:
|
|
|
288
288
|
projectstarter create fastapi myproject
|
|
289
289
|
```
|
|
290
290
|
|
|
291
|
-
|
|
291
|
+
projectstarter-cli automatically:
|
|
292
292
|
|
|
293
293
|
1. Creates the project directory.
|
|
294
294
|
2. Creates `.venv`.
|
|
@@ -406,7 +406,7 @@ projectstarter info fastapi
|
|
|
406
406
|
|
|
407
407
|
# 🩺 Doctor
|
|
408
408
|
|
|
409
|
-
|
|
409
|
+
projectstarter-cli includes a built-in diagnostic command:
|
|
410
410
|
|
|
411
411
|
```bash
|
|
412
412
|
projectstarter doctor
|
|
@@ -422,7 +422,7 @@ It checks:
|
|
|
422
422
|
Example:
|
|
423
423
|
|
|
424
424
|
```text
|
|
425
|
-
|
|
425
|
+
projectstarter-cli Doctor
|
|
426
426
|
──────────────────────────────
|
|
427
427
|
✓ Python
|
|
428
428
|
Version: 3.x.x
|
|
@@ -440,9 +440,9 @@ Everything looks good! ✓
|
|
|
440
440
|
|
|
441
441
|
---
|
|
442
442
|
|
|
443
|
-
# 🧪 Testing
|
|
443
|
+
# 🧪 Testing projectstarter-cli
|
|
444
444
|
|
|
445
|
-
|
|
445
|
+
projectstarter-cli uses `pytest` for automated testing.
|
|
446
446
|
|
|
447
447
|
Install pytest for development:
|
|
448
448
|
|
|
@@ -471,9 +471,9 @@ The test suite covers:
|
|
|
471
471
|
|
|
472
472
|
---
|
|
473
473
|
|
|
474
|
-
# 🏗️
|
|
474
|
+
# 🏗️ projectstarter-cli Development Structure
|
|
475
475
|
|
|
476
|
-
The
|
|
476
|
+
The projectstarter-cli source code is organized as follows:
|
|
477
477
|
|
|
478
478
|
```text
|
|
479
479
|
projectstarter/
|
|
@@ -545,7 +545,7 @@ Contains the automated test suite.
|
|
|
545
545
|
|
|
546
546
|
# ➕ Adding a New Generator
|
|
547
547
|
|
|
548
|
-
|
|
548
|
+
projectstarter-cli is designed so that new project types can be added to the generator system.
|
|
549
549
|
|
|
550
550
|
A new generator generally needs:
|
|
551
551
|
|
|
@@ -562,7 +562,7 @@ This keeps the CLI organized and makes the tool easier to extend.
|
|
|
562
562
|
|
|
563
563
|
# 🔐 Project Name Rules
|
|
564
564
|
|
|
565
|
-
|
|
565
|
+
projectstarter-cli validates project names before creating projects.
|
|
566
566
|
|
|
567
567
|
Valid examples:
|
|
568
568
|
|
|
@@ -586,9 +586,9 @@ Project names must use letters, numbers, and underscores and must not start with
|
|
|
586
586
|
|
|
587
587
|
# 👨💻 Author
|
|
588
588
|
|
|
589
|
-
**Mohamed Ali**
|
|
589
|
+
**Mohamed Ali Ismail Jami**
|
|
590
590
|
|
|
591
|
-
|
|
591
|
+
projectstarter-cli was created and is maintained by Mohamed Ali Ismail Jami.
|
|
592
592
|
|
|
593
593
|
## 📞 Contact
|
|
594
594
|
|
|
@@ -598,9 +598,9 @@ For questions, suggestions, bug reports, or contributions, contact the project m
|
|
|
598
598
|
- Project Repository: https://github.com/hamada-cool/projectstarter
|
|
599
599
|
- Bug Reports / Issues: https://github.com/hamada-cool/projectstarter/issues
|
|
600
600
|
- Email: `mohamedali32947@gmail.com`
|
|
601
|
-
- Phone / WhatsApp: `+918341391506`
|
|
601
|
+
- Phone / WhatsApp: `+918341391506` and `+249919532947`
|
|
602
602
|
|
|
603
|
-
You can also open a GitHub Issue if you find a bug or have an idea for improving
|
|
603
|
+
You can also open a GitHub Issue if you find a bug or have an idea for improving projectstarter-cli.
|
|
604
604
|
|
|
605
605
|
---
|
|
606
606
|
|
|
@@ -626,7 +626,7 @@ python -m pytest
|
|
|
626
626
|
|
|
627
627
|
# 📄 License
|
|
628
628
|
|
|
629
|
-
|
|
629
|
+
projectstarter-cli is licensed under the **MIT License**.
|
|
630
630
|
|
|
631
631
|
See the `LICENSE` file for the complete license text.
|
|
632
632
|
|
|
@@ -634,7 +634,7 @@ See the `LICENSE` file for the complete license text.
|
|
|
634
634
|
|
|
635
635
|
# 🎯 Project Status
|
|
636
636
|
|
|
637
|
-
|
|
637
|
+
projectstarter-cli currently supports:
|
|
638
638
|
|
|
639
639
|
- Python
|
|
640
640
|
- Django
|
|
@@ -647,7 +647,7 @@ The project is under active development, and more generators and features may be
|
|
|
647
647
|
|
|
648
648
|
## ⭐ Support the Project
|
|
649
649
|
|
|
650
|
-
If you find
|
|
650
|
+
If you find projectstarter-cli useful, you can support the project by:
|
|
651
651
|
|
|
652
652
|
- ⭐ Starring the GitHub repository
|
|
653
653
|
- 🐛 Reporting bugs
|
|
@@ -657,6 +657,6 @@ If you find ProjectStarter useful, you can support the project by:
|
|
|
657
657
|
|
|
658
658
|
---
|
|
659
659
|
|
|
660
|
-
**
|
|
660
|
+
**projectstarter-cli — Start your next Python project faster. 🚀**
|
|
661
661
|
|
|
662
|
-
Created by **Mohamed Ali**.
|
|
662
|
+
Created by **Mohamed Ali Ismail Jami**.
|
|
@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
|
|
|
5
5
|
|
|
6
6
|
[project]
|
|
7
7
|
name = "projectstarter-cli"
|
|
8
|
-
version = "0.1.
|
|
8
|
+
version = "0.1.1"
|
|
9
9
|
description = "A Python CLI tool for quickly generating Python, Django, Flask, and FastAPI projects"
|
|
10
10
|
readme = "README.md"
|
|
11
11
|
requires-python = ">=3.9"
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter_cli.egg-info/SOURCES.txt
RENAMED
|
File without changes
|
|
File without changes
|
{projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter_cli.egg-info/entry_points.txt
RENAMED
|
File without changes
|
{projectstarter_cli-0.1.0 → projectstarter_cli-0.1.1}/projectstarter_cli.egg-info/top_level.txt
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|