dscforge 0.1.1__tar.gz → 0.1.2__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.
Files changed (49) hide show
  1. {dscforge-0.1.1 → dscforge-0.1.2}/LICENSE +21 -21
  2. {dscforge-0.1.1/dscforge.egg-info → dscforge-0.1.2}/PKG-INFO +9 -9
  3. {dscforge-0.1.1 → dscforge-0.1.2}/README.md +153 -153
  4. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/cli.py +29 -29
  5. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/generator.py +133 -128
  6. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/basic/main.py +8 -8
  7. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/.gitignore +17 -17
  8. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/README.md +55 -55
  9. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/src/config.py +32 -32
  10. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/src/main.py +13 -13
  11. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/src/utils.py +10 -10
  12. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/tests/test.py +14 -14
  13. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/web/pages/index.html +19 -19
  14. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/standard/.gitignore +14 -14
  15. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/standard/README.md +36 -36
  16. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/standard/src/main.py +10 -10
  17. {dscforge-0.1.1 → dscforge-0.1.2/dscforge.egg-info}/PKG-INFO +9 -9
  18. {dscforge-0.1.1 → dscforge-0.1.2}/pyproject.toml +14 -14
  19. {dscforge-0.1.1 → dscforge-0.1.2}/setup.cfg +4 -4
  20. {dscforge-0.1.1 → dscforge-0.1.2}/MANIFEST.in +0 -0
  21. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/__init__.py +0 -0
  22. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/basic/main.ipynb +0 -0
  23. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/data/processed/.gitkeep +0 -0
  24. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/data/raw/.gitkeep +0 -0
  25. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/figures/.gitkeep +0 -0
  26. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/logs/.gitkeep +0 -0
  27. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/logs/app.log +0 -0
  28. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/models/.gitkeep +0 -0
  29. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/notebooks/.gitkeep +0 -0
  30. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/notebooks/main.ipynb +0 -0
  31. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/src/.gitkeep +0 -0
  32. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/src/__init__.py +0 -0
  33. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/tests/.gitkeep +0 -0
  34. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/web/pages/.gitkeep +0 -0
  35. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/web/scripts/.gitkeep +0 -0
  36. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/web/scripts/main.js +0 -0
  37. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/web/styles/.gitkeep +0 -0
  38. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/premium/web/styles/style.css +0 -0
  39. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/standard/data/.gitkeep +0 -0
  40. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/standard/figures/.gitkeep +0 -0
  41. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/standard/notebooks/.gitkeep +0 -0
  42. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/standard/notebooks/main.ipynb +0 -0
  43. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/templates/standard/src/.gitkeep +0 -0
  44. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge/utils.py +0 -0
  45. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge.egg-info/SOURCES.txt +0 -0
  46. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge.egg-info/dependency_links.txt +0 -0
  47. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge.egg-info/entry_points.txt +0 -0
  48. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge.egg-info/requires.txt +0 -0
  49. {dscforge-0.1.1 → dscforge-0.1.2}/dscforge.egg-info/top_level.txt +0 -0
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 j2doan
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2026 j2doan
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -1,9 +1,9 @@
1
- Metadata-Version: 2.4
2
- Name: dscforge
3
- Version: 0.1.1
4
- Summary: CLI tool for generating data science project templates
5
- Author: Jacob Doan
6
- Requires-Python: >=3.8
7
- License-File: LICENSE
8
- Requires-Dist: click
9
- Dynamic: license-file
1
+ Metadata-Version: 2.4
2
+ Name: dscforge
3
+ Version: 0.1.2
4
+ Summary: CLI tool for generating data science project templates
5
+ Author: Jacob Doan
6
+ Requires-Python: >=3.8
7
+ License-File: LICENSE
8
+ Requires-Dist: click
9
+ Dynamic: license-file
@@ -1,153 +1,153 @@
1
- # Welcome to dscforge!
2
-
3
- A CLI tool to quickly generate data science project templates.
4
-
5
- ## Installation
6
-
7
- ```bash
8
- pip install dscforge
9
- ```
10
-
11
- ## Usage
12
-
13
- ### Step 1:
14
-
15
- Navigate to the directory where you want your project created.
16
-
17
- ### Step 2:
18
-
19
- Run the command below:
20
-
21
- ```bash
22
- dscforge <project_name>
23
- ```
24
-
25
- ### Flags
26
-
27
- - `--template <template_type>` : generates using the specified template
28
- - `--git` : initializes git when generating the template
29
-
30
- ## Example Usages
31
-
32
- - `dscforge my_project` : Creates a default basic project template called "my_project".
33
- - `dscforge my_project --template basic` : Creates a basic project template called "my_project".
34
- - `dscforge my_project --template standard` : Creates a standard project template called "my_project".
35
- - `dscforge my_project --template premium` : Creates a premium project template called "my_project".
36
- - `dscforge my_project --git` : Creates a default basic project template called "my_project" with git initialization.
37
- - `dscforge my_project --template basic --git` : Creates a basic project template called "my_project" with git initialization.
38
- - `dscforge my_project --template standard --git` : Creates a standard project template called "my_project" with git initialization.
39
- - `dscforge my_project --template premium --git` : Creates a premium project template called "my_project" with git initialization.
40
-
41
- # Project Templates
42
-
43
- ## Basic Template
44
-
45
- A minimal setup for quick experiments, scripts, or small assignments.
46
-
47
- ```text id="basic_md"
48
- my_project/
49
- ├── main.py
50
- ├── main.ipynb
51
- ```
52
-
53
- ### What it’s for
54
-
55
- * Quick prototyping
56
- * Small coursework / assignments
57
- * Scratch work / experiments
58
- * No setup overhead
59
-
60
- ---
61
-
62
- ## Standard Template
63
-
64
- A structured setup for data science coursework and small projects.
65
-
66
- ```text id="standard_md"
67
- my_project/
68
- ├── data/
69
- │ ├── raw/
70
- │ └── processed/
71
- │
72
- ├── figures/
73
- │
74
- ├── notebooks/
75
- │ └── main.ipynb
76
- │
77
- ├── src/
78
- │ └── main.py
79
- │
80
- ├── .gitignore
81
- ├── pyproject.toml
82
- ├── README.md
83
- └── requirements.txt
84
- ```
85
-
86
- ### What it’s for
87
-
88
- * Data analysis projects
89
- * Coursework / assignments with datasets
90
- * Small research projects
91
- * Clean separation of code and data
92
-
93
- ### Each standard template includes its own isolated virtual environment (`.venv`)
94
- - Dependencies: numpy, pandas, matplotlib, ipykernel
95
-
96
- ---
97
-
98
- ## Premium Template
99
-
100
- A production-style data science project structure with scalability in mind.
101
-
102
- ```text id="premium_md"
103
- my_project/
104
- ├── data/
105
- │ ├── raw/
106
- │ └── processed/
107
- │
108
- ├── figures/
109
- │
110
- ├── logs/
111
- │ └── app.log
112
- │
113
- ├── models/
114
- │
115
- ├── notebooks/
116
- │ └── main.ipynb
117
- │
118
- ├── src/
119
- │ ├── __init__.py
120
- │ ├── config.py
121
- │ ├── main.py
122
- │ └── utils.py
123
- │
124
- ├── tests/
125
- │ └── test.py
126
- │
127
- ├── web/
128
- │ ├── pages/
129
- │ │ └── index.html
130
- │ ├── styles/
131
- │ │ └── style.css
132
- │ └── scripts/
133
- │ └── main.js
134
- │
135
- ├── .gitignore
136
- ├── pyproject.toml
137
- ├── README.md
138
- └── requirements.txt
139
- ```
140
-
141
- ### What it’s for
142
-
143
- * End-to-end data science projects
144
- * Research pipelines
145
- * ML experimentation
146
- * Dashboards or web-integrated projects
147
- * Scalable production-like structure
148
-
149
- ### Each premium template includes its own isolated virtual environment (`.venv`)
150
- - Dependencies: numpy, pandas, matplotlib, ipykernel
151
-
152
- ---
153
-
1
+ # dscforge
2
+
3
+ **dscforge** is a command-line tool that forges complete data science project structures from a single command. Skip the tedious setup and start every project with a clean, organized foundation. Generate anything from lightweight experiment environments to production-style project layouts with the snap of a finger!
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ pip install dscforge
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ### Step 1:
14
+
15
+ Navigate to the directory where you want your project created.
16
+
17
+ ### Step 2:
18
+
19
+ Run the command below:
20
+
21
+ ```bash
22
+ dscforge <project_name>
23
+ ```
24
+
25
+ ### Flags
26
+
27
+ - `--template <template_type>` : generates using the specified template
28
+ - `--git` : initializes git when generating the template
29
+
30
+ ## Example Usages
31
+
32
+ - `dscforge my_project` : Creates a default basic project template called "my_project".
33
+ - `dscforge my_project --template basic` : Creates a basic project template called "my_project".
34
+ - `dscforge my_project --template standard` : Creates a standard project template called "my_project".
35
+ - `dscforge my_project --template premium` : Creates a premium project template called "my_project".
36
+ - `dscforge my_project --git` : Creates a default basic project template called "my_project" with git initialization.
37
+ - `dscforge my_project --template basic --git` : Creates a basic project template called "my_project" with git initialization.
38
+ - `dscforge my_project --template standard --git` : Creates a standard project template called "my_project" with git initialization.
39
+ - `dscforge my_project --template premium --git` : Creates a premium project template called "my_project" with git initialization.
40
+
41
+ # Project Templates
42
+
43
+ ## Basic Template
44
+
45
+ A minimal setup for quick experiments, scripts, or small assignments.
46
+
47
+ ```text id="basic_md"
48
+ my_project/
49
+ ├── main.py
50
+ ├── main.ipynb
51
+ ```
52
+
53
+ ### What it’s for
54
+
55
+ * Quick prototyping
56
+ * Small coursework / assignments
57
+ * Scratch work / experiments
58
+ * No setup overhead
59
+
60
+ ---
61
+
62
+ ## Standard Template
63
+
64
+ A structured setup for data science coursework and small projects.
65
+
66
+ ```text id="standard_md"
67
+ my_project/
68
+ ├── data/
69
+ │ ├── raw/
70
+ │ └── processed/
71
+ │
72
+ ├── figures/
73
+ │
74
+ ├── notebooks/
75
+ │ └── main.ipynb
76
+ │
77
+ ├── src/
78
+ │ └── main.py
79
+ │
80
+ ├── .gitignore
81
+ ├── pyproject.toml
82
+ ├── README.md
83
+ └── requirements.txt
84
+ ```
85
+
86
+ ### What it’s for
87
+
88
+ * Data analysis projects
89
+ * Coursework / assignments with datasets
90
+ * Small research projects
91
+ * Clean separation of code and data
92
+
93
+ ### Each standard template includes its own isolated virtual environment (`.venv`)
94
+ - Dependencies: numpy, pandas, matplotlib, ipykernel
95
+
96
+ ---
97
+
98
+ ## Premium Template
99
+
100
+ A production-style data science project structure with scalability in mind.
101
+
102
+ ```text id="premium_md"
103
+ my_project/
104
+ ├── data/
105
+ │ ├── raw/
106
+ │ └── processed/
107
+ │
108
+ ├── figures/
109
+ │
110
+ ├── logs/
111
+ │ └── app.log
112
+ │
113
+ ├── models/
114
+ │
115
+ ├── notebooks/
116
+ │ └── main.ipynb
117
+ │
118
+ ├── src/
119
+ │ ├── __init__.py
120
+ │ ├── config.py
121
+ │ ├── main.py
122
+ │ └── utils.py
123
+ │
124
+ ├── tests/
125
+ │ └── test.py
126
+ │
127
+ ├── web/
128
+ │ ├── pages/
129
+ │ │ └── index.html
130
+ │ ├── styles/
131
+ │ │ └── style.css
132
+ │ └── scripts/
133
+ │ └── main.js
134
+ │
135
+ ├── .gitignore
136
+ ├── pyproject.toml
137
+ ├── README.md
138
+ └── requirements.txt
139
+ ```
140
+
141
+ ### What it’s for
142
+
143
+ * End-to-end data science projects
144
+ * Research pipelines
145
+ * ML experimentation
146
+ * Dashboards or web-integrated projects
147
+ * Scalable production-like structure
148
+
149
+ ### Each premium template includes its own isolated virtual environment (`.venv`)
150
+ - Dependencies: numpy, pandas, matplotlib, ipykernel
151
+
152
+ ---
153
+
@@ -1,30 +1,30 @@
1
- # Imports
2
- import click
3
- from .generator import create_project
4
-
5
- @click.command()
6
- @click.argument("name")
7
-
8
- # Click option for --template
9
- @click.option(
10
- "--template",
11
- type=click.Choice(["basic", "standard", "premium"]),
12
- default="basic",
13
- show_default=True,
14
- help="Select a project template"
15
- )
16
-
17
- # Click option for --git
18
- @click.option(
19
- "--git",
20
- is_flag=True,
21
- default=False,
22
- help="Initialize a git repository in the project"
23
- )
24
-
25
- # Creating the template
26
- def main(name, template, git):
27
- create_project(name, template, git)
28
-
29
- if __name__ == "__main__":
1
+ # Imports
2
+ import click
3
+ from .generator import create_project
4
+
5
+ @click.command()
6
+ @click.argument("name")
7
+
8
+ # Click option for --template
9
+ @click.option(
10
+ "--template",
11
+ type=click.Choice(["basic", "standard", "premium"]),
12
+ default="basic",
13
+ show_default=True,
14
+ help="Select a project template"
15
+ )
16
+
17
+ # Click option for --git
18
+ @click.option(
19
+ "--git",
20
+ is_flag=True,
21
+ default=False,
22
+ help="Initialize a git repository in the project"
23
+ )
24
+
25
+ # Creating the template
26
+ def main(name, template, git):
27
+ create_project(name, template, git)
28
+
29
+ if __name__ == "__main__":
30
30
  main()