forgepy-cli 1.0.0__py3-none-any.whl

forgepy_cli-1.0.0.dist-info/METADATA

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: forgepy-cli
+Version: 1.0.0
+Summary: Create structured Python projects and prepare their development tooling.
+Author: Rendy Zou
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/rzou89/ForgePy
+Project-URL: Repository, https://github.com/rzou89/ForgePy
+Project-URL: Issues, https://github.com/rzou89/ForgePy/issues
+Keywords: python,project-generator,cli,windows
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# ForgePy
+
+ForgePy is a Windows-focused command-line tool that creates structured Python projects and prepares their development tooling.
+
+## What ForgePy Does
+
+ForgePy generates a project from one of its built-in templates, creates a virtual environment, installs the generated requirements, writes VS Code configuration, and initializes the project as a Git repository with an initial commit. It also provides optional components that can add focused configuration files to an existing project.
+
+## Requirements
+
+- Windows 10 or Windows 11
+- CPython 3.12 or newer
+- Git, required for project creation and configured with the user name and email needed to create a commit
+
+Other operating systems and alternative Python implementations are not officially supported for ForgePy v1.0.
+
+Repository CI tests ForgePy on GitHub-hosted `windows-latest` runners using CPython 3.12, 3.13, and 3.14. This verifies compatibility with the hosted Windows environment; it does not literally test native Windows 10 and Windows 11 client installations.
+
+## Installation
+
+ForgePy is prepared for PyPI publication under the distribution name
+`forgepy-cli`. After that first publication, install it with:
+
+```powershell
+python -m pip install forgepy-cli
+```
+
+The PyPI upload is still pending. Until it is completed, install from source as
+described below or use the existing GitHub v1.0.0 release artifacts.
+
+From a ForgePy source checkout, install the command with:
+
+```powershell
+python -m pip install .
+```
+
+For editable development work, use:
+
+```powershell
+python -m pip install -e .
+```
+
+## Quick Start
+
+Check the installed versions and available templates:
+
+```powershell
+forgepy version
+forgepy list
+```
+
+Create a basic project below an existing parent directory:
+
+```powershell
+forgepy create MyProject --location C:\Projects --template basic
+cd C:\Projects\MyProject
+```
+
+The destination must not already exist. Omitting the project name or location starts the corresponding prompt; an omitted template uses the configured default and then falls back to `basic`.
+
+## Available Templates
+
+- `basic` - a basic application starter with a structured directory layout, `app.py`, project metadata, environment files, and generated requirements.
+- `library` - a minimal reusable Python package with a normalized import-package directory and a `tests` package.
+- `cli` - a minimal command-line package with `__main__.py`, an argparse interface, help and version behavior, and a `tests` package.
+
+List the registered templates at any time with `forgepy list`.
+
+## Components
+
+Components add one focused configuration file to an explicitly supplied existing project directory. ForgePy records successful component installations in project-local state.
+
+Available components are:
+
+- `pytest` - adds `pytest.ini`.
+- `ruff` - adds `ruff.toml`.
+- `github-actions` - adds a minimal `.github/workflows/ci.yml` for the generated project.
+
+Use the verified component commands:
+
+```powershell
+forgepy component list
+forgepy component add pytest --project C:\Projects\MyProject
+forgepy component installed --project C:\Projects\MyProject
+```
+
+Component installation refuses an owned target that already exists. The generated-project `github-actions` component is separate from ForgePy's own repository CI workflow.
+
+## Configuration
+
+ForgePy stores user configuration under `~/.forgepy/config.json`. Supported settings are `default_template`, `default_location`, `author`, and `license`.
+
+```powershell
+forgepy config show
+forgepy config set default_template library
+forgepy config set default_location C:\Projects
+forgepy config reset
+```
+
+Only `default_template` and `default_location` currently affect project creation. `author` and `license` are persisted but are not applied to generated files.
+
+Explicit `create` options take priority over configuration. See all supported syntax with:
+
+```powershell
+forgepy create --help
+forgepy config --help
+```
+
+## Project Creation Lifecycle
+
+A successful `forgepy create` runs these stages in order:
+
+1. Generate the selected template.
+2. Create `.venv`.
+3. Update `pip`, `setuptools`, and `wheel` in that environment.
+4. Install the generated `requirements.txt`.
+5. Write VS Code configuration.
+6. Run `git init`.
+7. Run `git add .`.
+8. Create the initial Git commit.
+9. Report full success.
+
+Git is a required part of successful project creation. Packaging-tool updates and dependency installation may require network access.
+
+## Failure and Partial Projects
+
+If creation fails after ForgePy creates the destination, later stages stop and full success is not reported. Files generated by earlier stages may remain in the destination because ForgePy does not automatically roll back or clean up a partial project.
+
+Inspect the destination and remove it when appropriate before retrying. ForgePy project creation is not transactional or atomic.
+
+## Development
+
+Run the standard local validation from the repository root:
+
+```powershell
+python -m unittest discover -s tests -v
+python -m compileall -q components cli templates core config builders models tests
+```
+
+Repository CI runs the test suite, compilation check, and packaging/support tests on `windows-latest` with CPython 3.12, 3.13, and 3.14. Its Python 3.12 job also builds and inspects the wheel and sdist, installs the wheel in isolation, and exercises the installed CLI.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for repository workflow and review expectations.
+
+## Current Status
+
+ForgePy v1.0.0 is the current stable Git tag and GitHub Release. The application
+and command remain named ForgePy and `forgepy`; only the prepared PyPI
+distribution name is `forgepy-cli`. Trusted Publishing is configured in the
+repository, but the first PyPI upload has not occurred.
+
+## License
+
+ForgePy is licensed under the [MIT License](LICENSE).

forgepy_cli-1.0.0.dist-info/RECORD

@@ -0,0 +1,74 @@
+main.py,sha256=b6pnUHEuAWbxnY6Nv_y27dMdmXW0yG9uhMAKREjXqZE,388
+builders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+builders/base_builder.py,sha256=93Y57jc2g6HrWmSIQGsr_800_vXj9BJlYda9N9Esln0,320
+builders/file_builder.py,sha256=sWZ_3bUSC5cGdfngwsmOAVcDbnEcwP_kOqqgmJ958x0,558
+builders/folder_builder.py,sha256=_BsDubymSD-ddFFWJyxonzNe1iGRERE09HqqrSzHgeg,563
+builders/python_tools_builder.py,sha256=ITRoAdnyZBaViqclpWENyzLZEw6lizML9592xCs3_5c,1557
+cli/__init__.py,sha256=GyGkgk8eLqUOaW69TRbW50sRNjC-wgJWls4jcTn-LXI,27
+cli/command.py,sha256=uuWh3-sswzqODlk17PI0M19vh5I-QA3E2rq1UwEeL8g,1230
+cli/dispatcher.py,sha256=WfXMcmrOSd4dmUVF1HTKtR71Tcj6GUA7GDQUK3IHV-I,1603
+cli/parser.py,sha256=CnheRTyPcSsrUqUbxSwMsczsmTQwiy13_uRx6kp01o0,2078
+cli/commands/__init__.py,sha256=DluqEyUZvcjBN5yFXQ5um5qMCyce4hrPMC0FaGF5UJY,811
+cli/commands/component_command.py,sha256=EceEwm7a35kv6ArftQj0KybIhtWOzGbhbLWWXz1TK_Q,5699
+cli/commands/config_command.py,sha256=q9tKqf_RVW60UBWMWEPCRzjJZUIf58NjQlFUzZQJgBg,4596
+cli/commands/create_command.py,sha256=xJhEWL-syTzFNoYQENTgaOlhtMTkqna2LfbUL5ZsoE0,4274
+cli/commands/list_command.py,sha256=CJLYVq8A2NB6Rc0_-spGONGUzB84l-0bAveJB4MjHyM,1005
+cli/commands/version_command.py,sha256=2G5sECxLcXlOkavt61wMnt8qicv7dRFXJh3RjXzX9ic,702
+components/__init__.py,sha256=WVuBkH-RaNkLbl-DeUv-xJlpcqB0Grvs0u6JSgJLh70,75
+components/base_component.py,sha256=nOIz2x3LfBE7IPAxSDsqKJz9ar1TK02gK0RAISLBmGg,959
+components/component_context.py,sha256=GIbxc02z7nZWY6k7TTPLCW5Xw6F4qwchdXL-zfEhh1E,684
+components/component_installer.py,sha256=pC_ouPWKClWma4lHyGvXmNqn-W1RYKN8paxYvzrZxLs,1565
+components/component_manifest.py,sha256=eazybMxZP83cffC4ZBKbL6pw9KB_Yv0IBATdaBpXlyc,3450
+components/component_metadata.py,sha256=VPCB8inRJZ5cf20FrPb1r_dih8aVXGWSzwRkqlUvjnA,1442
+components/component_registry.py,sha256=5nHV395XZ28tWrHlN-Q__v0e5BPIcSs01J9tSLC-N5k,2583
+components/component_state.py,sha256=lWPQ6Lp5RCe2emPbdF-_o57SC6X__D_nnPNgmaLR2Ak,8493
+components/component_validation.py,sha256=G01qnZQxRsZ-dZZRv2XBEMzGRvV1EfpDKYHTlImpdk0,2529
+components/github_actions_component.py,sha256=iJQ6Zko8P9jpceR-kLFuMb7mSQFTbSgP-UoIl4v_0Po,2353
+components/pytest_component.py,sha256=4osYfeqJNwPNyHaf-geSICxCaQW_Xln4dZfIa5vNUyU,1267
+components/ruff_component.py,sha256=doBSCSkBS2tAhZmoFa9FUY6M8nkje5DP5qaZEN_Quek,1269
+config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+config/default_structure.py,sha256=0CvLUkvuau3oD0EVDTx8MyQSBPCkj66QiOr7eXD5tk8,239
+config/user_config.py,sha256=dPoj_rT_uWyKrE2x8n503VW5VJLFMOFuSbFeyhW5qKg,6324
+config/version.py,sha256=GNbZRpnwmOdVGz-W3YD_6OcNpGTk9pTCzw36skpoxZY,298
+core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+core/environment_builder.py,sha256=_2BFYiob1ysXqNMqkXiwoeuaAjeewlsF5p3qM8ZP5U0,804
+core/git_builder.py,sha256=VDL5dVRi4FjnExWTVvj598J8zkCqvWbME5c1ZvIzdCw,2352
+core/project_generator.py,sha256=zuTcXsmw6yospLy-Gw_MgWPzlnYhRJ5xS9nVHW-fOEA,3436
+core/requirements_installer.py,sha256=ogrPihmuaY9eSJ0IZTpQApY2B88xHEB0WViYwnzn4kE,1424
+core/vscode_builder.py,sha256=sYD3Gu-3RVzLDezv-M_NuUsy43Iqy0Mg883-tII-QIg,2267
+forgepy_cli-1.0.0.dist-info/licenses/LICENSE,sha256=B5ugZWNQROTsTHRoWA5qYURkUwuYVFUKqUKQtEQzneA,1066
+models/__init__.py,sha256=Mu55KWWsOYHH8rrzhilWR3bq2QunBzhK_P1bXnqGdIY,52
+models/project_config.py,sha256=fn7UsE7ktKk9bGZFKgRoYBOtOC_GT56p-c4aQNLJbVQ,2848
+templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+templates/app_template.py,sha256=ES6ByNI-qpaeAZKdwFAdZDunzwFzKCoh2D0dIF1hSvs,305
+templates/changelog_template.py,sha256=byHUpbVgayl4_hBqalB3oPnbZWFgZrQErLlbblaNazI,245
+templates/env_template.py,sha256=XZ0Qa8TaR5d3vKsrcuewupD5oVv0bsVdEh8a2u4Q8WI,323
+templates/gitignore_template.py,sha256=eXGaeNSvT0Ecxcyrw-Aq1Sc7kYPk9_Hl10Xf6VSUHjI,273
+templates/license_template.py,sha256=7VfxquTVn1TT8vC5pVzh1RxbWWdSwouD3tI3mU8yAgg,643
+templates/pyproject_template.py,sha256=eyzv4SCle7tWCdPnCPL78rHIQ_mZR_-g1cY1bkQc04U,298
+templates/readme_template.py,sha256=IbJ3756guBgDC7igTBeHRiCLaatALm5vYJLV8llH_9w,250
+templates/requirements_template.py,sha256=i5-PI3tESKp25jwD_hv7m9ouHvHxVQzuOIhg8_EgEeA,214
+templates/template_manager.py,sha256=wjHhdj3FLs6AyHL0PUKRDSyaw4mhIS9jzpt7wKoCEAs,1353
+templates/basic/basic_files.py,sha256=vAw46wnTXZ5WFcfGHFlTPxZQh3TXYB3g2F4kRl0Hc1c,903
+templates/basic/basic_template.py,sha256=iVlagxTfSfDjmZwuixvDQ9qn6psVa-s4tC9Dzh4LK1o,989
+templates/cli/cli_files.py,sha256=i6zxYap2z-hSohOdjai99lJ9wmwYPUvozKRw2PjN_EA,1794
+templates/cli/cli_template.py,sha256=DsQ2gkwiBikBvv4sd8nryLHVp7NC17V3jjCaLrEi1yg,1694
+templates/library/library_files.py,sha256=xaFk0o_ZH-EVk4Z84AVMXagDwbEpqUJJ_QPEA2ROI7I,800
+templates/library/library_template.py,sha256=5U7rNa6OPMDh_Ura2Mr_xgg0oxV2u5K9cVLH_o5edpQ,1681
+templates/template_engine/base_template.py,sha256=HliAH73pBjdImlVjQgdz5sd8Ul4MvXkAE0JlxAbZXRI,1251
+templates/template_engine/file_template.py,sha256=BBVezXHxXLqqKbvU_NSEgJEncggHUjTpzu25GLQ37rQ,2366
+templates/template_engine/package_name.py,sha256=a04IsqwEH7JFFoOTdWc05LVzbzPe0S5LbJLTdz60XVs,652
+templates/template_engine/template_context.py,sha256=LctJePzdwZvJhefWEULDhPfU3ilkIPd0Scb4sOjZeS8,671
+templates/template_engine/template_files.py,sha256=GIS6dXyfj8okXo_GpoZv-V6NPuP827GsZfBKSE59c5k,261
+templates/template_engine/template_metadata.py,sha256=k6YYRegXjfZIXSVfnYvzpEpgDvR-4hLOs6rYCSvAaB8,1547
+templates/template_engine/template_registry.py,sha256=LzDPKcAsSNHNx172hV4O_xFKE-3mcmCraZWXb9-Npdo,3051
+templates/vscode/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+templates/vscode/extensions_template.py,sha256=uK8T_O_IhOHUN5qD-_P43nAFZpv8nkf6ugDieBCFFF8,642
+templates/vscode/launch_template.py,sha256=UsutOs-jvusU0PcHtOk4q1yeTYlvi9bU2aRefw6r8eE,956
+templates/vscode/settings_template.py,sha256=grpNQmkTnBNzM0zjL_2XkTTBlNICZgYMPZqGjFC9WN4,712
+templates/vscode/tasks_template.py,sha256=DKoG1NlQ3uVFMS0a8nGUYYRzxqap35krnUKJ2bxC_y8,1570
+forgepy_cli-1.0.0.dist-info/METADATA,sha256=NhIT-r1jNlHsvMrKn0oKyHbcRkvg5feD7nmAB8ptcsg,6762
+forgepy_cli-1.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+forgepy_cli-1.0.0.dist-info/entry_points.txt,sha256=HXynpYTvHhzdaIFpEUkP2LBo9KYb04rnipn1yeiJb_k,38
+forgepy_cli-1.0.0.dist-info/top_level.txt,sha256=RPhRDjNEazNrrMCb2uOUBYt6i1jnM3o2cVQuYlCFpaQ,58
+forgepy_cli-1.0.0.dist-info/RECORD,,

forgepy_cli-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

forgepy_cli-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+forgepy = main:main

forgepy_cli-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rendy Zou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

forgepy_cli-1.0.0.dist-info/top_level.txt

@@ -0,0 +1,8 @@
+builders
+cli
+components
+config
+core
+main
+models
+templates

main.py

@@ -0,0 +1,20 @@
+"""
+==================================================
+ForgePy
+Module  : Application Entry Point
+==================================================
+"""
+
+from cli.dispatcher import Dispatcher
+from cli.parser import Parser
+
+
+def main() -> int:
+    parser = Parser()
+    args = parser.parse()
+
+    return Dispatcher().dispatch(args)
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

models/__init__.py

@@ -0,0 +1 @@
+"""Project data models distributed with ForgePy."""

models/project_config.py

@@ -0,0 +1,87 @@
+from dataclasses import dataclass
+from pathlib import Path, PureWindowsPath
+import unicodedata
+
+
+WINDOWS_INVALID_NAME_CHARACTERS = frozenset('<>:"/\\|?*')
+WINDOWS_RESERVED_NAME_STEMS = frozenset(
+    {"CON", "PRN", "AUX", "NUL"}
+    | {f"COM{number}" for number in range(1, 10)}
+    | {f"LPT{number}" for number in range(1, 10)}
+    | {f"COM{number}" for number in ("¹", "²", "³")}
+    | {f"LPT{number}" for number in ("¹", "²", "³")}
+)
+
+
+@dataclass(slots=True)
+class ProjectConfig:
+    """
+    Menyimpan konfigurasi project.
+    """
+
+    name: str
+    location: Path
+
+    def __post_init__(self) -> None:
+        """Validate the name used to construct the project destination."""
+
+        if not isinstance(self.name, str):
+            raise TypeError("Project name must be a string.")
+
+        if not self.name:
+            raise ValueError("Project name must not be empty.")
+
+        if not self.name.strip():
+            raise ValueError("Project name must not contain only whitespace.")
+
+        if self.name.startswith(" "):
+            raise ValueError("Project name must not begin with an ASCII space.")
+
+        if self.name in {".", ".."}:
+            raise ValueError("Project name must be one filesystem path segment.")
+
+        if any(
+            character in WINDOWS_INVALID_NAME_CHARACTERS
+            for character in self.name
+        ):
+            raise ValueError(
+                "Project name contains a Windows-invalid filename character."
+            )
+
+        if any(
+            unicodedata.category(character) == "Cc"
+            for character in self.name
+        ):
+            raise ValueError("Project name must not contain control characters.")
+
+        try:
+            self.name.encode("utf-8")
+        except UnicodeEncodeError as error:
+            raise ValueError(
+                "Project name must be valid Unicode for UTF-8 output."
+            ) from error
+
+        if self.name.endswith((" ", ".")):
+            raise ValueError("Project name must not end with a space or dot.")
+
+        reserved_stem = self.name.split(".", maxsplit=1)[0].upper()
+        if reserved_stem in WINDOWS_RESERVED_NAME_STEMS:
+            raise ValueError(
+                "Project name must not use a Windows reserved device name."
+            )
+
+        path_name = Path(self.name)
+        windows_name = PureWindowsPath(self.name)
+
+        if path_name.is_absolute() or windows_name.is_absolute():
+            raise ValueError("Project name must not be an absolute path.")
+
+        if windows_name.drive:
+            raise ValueError("Project name must not be drive-qualified.")
+
+        if len(path_name.parts) != 1 or len(windows_name.parts) != 1:
+            raise ValueError("Project name must be one filesystem path segment.")
+
+    @property
+    def root(self) -> Path:
+        return self.location / self.name

templates/app_template.py

@@ -0,0 +1,20 @@
+"""
+==================================================
+ForgePy
+App Template
+==================================================
+"""
+
+
+def get_app(project_name: str) -> str:
+    return f'''"""
+{project_name}
+"""
+
+def main():
+    print("Welcome to {project_name}")
+
+
+if __name__ == "__main__":
+    main()
+'''

templates/basic/basic_files.py

@@ -0,0 +1,23 @@
+"""Generated file mapping owned by the basic template."""
+
+from templates.template_manager import TemplateManager
+
+
+class BasicFiles:
+    """Build the established basic-template file mapping."""
+
+    @staticmethod
+    def build(project_name: str) -> dict[str, str]:
+        template_manager = TemplateManager()
+
+        return {
+            "README.md": template_manager.get_readme(project_name),
+            ".gitignore": template_manager.get_gitignore(),
+            "requirements.txt": template_manager.get_requirements(),
+            "app.py": template_manager.get_app(project_name),
+            "LICENSE": template_manager.get_license(),
+            "CHANGELOG.md": template_manager.get_changelog(),
+            ".env": template_manager.get_env(),
+            ".env.example": template_manager.get_env_example(),
+            "pyproject.toml": template_manager.get_pyproject(project_name),
+        }

templates/basic/basic_template.py

@@ -0,0 +1,32 @@
+"""
+==================================================
+ForgePy
+Basic Template
+==================================================
+"""
+
+from config.default_structure import DEFAULT_FOLDERS
+from templates.basic.basic_files import BasicFiles
+from templates.template_engine.file_template import FileTemplate
+from templates.template_engine.template_context import TemplateContext
+from templates.template_engine.template_metadata import TemplateMetadata
+
+
+class BasicTemplate(FileTemplate):
+
+    _METADATA = TemplateMetadata(
+        name="basic",
+        description="Basic Python project starter template.",
+        version="0.6.0",
+        author="Rendy Zou",
+        tags=("python", "basic"),
+    )
+
+    _DEFAULT_VSCODE_ENTRY_POINT = "app.py"
+
+    def _folders(self, context: TemplateContext) -> tuple[str, ...]:
+        del context
+        return tuple(DEFAULT_FOLDERS)
+
+    def _files(self, context: TemplateContext) -> dict[str, str]:
+        return BasicFiles.build(context.project_name)

templates/changelog_template.py

@@ -0,0 +1,15 @@
+"""
+==================================================
+ForgePy
+Changelog Template
+==================================================
+"""
+
+
+def get_changelog() -> str:
+    return """# Changelog
+
+## v1.0.0
+
+- Initial project created by ForgePy
+"""

templates/cli/cli_files.py

@@ -0,0 +1,70 @@
+from templates.template_manager import TemplateManager
+
+
+_GENERATED_APP_VERSION = "0.1.0"
+
+
+class CliFiles:
+    """Build the minimal file mapping for a command-line application."""
+
+    @staticmethod
+    def build(
+        project_name: str,
+        package_name: str,
+    ) -> dict[str, str]:
+        template_manager = TemplateManager()
+
+        return {
+            "README.md": template_manager.get_readme(project_name),
+            ".gitignore": template_manager.get_gitignore(),
+            "requirements.txt": "",
+            "pyproject.toml": template_manager.get_pyproject(project_name),
+            f"{package_name}/__init__.py": "",
+            f"{package_name}/__main__.py": CliFiles._build_main(),
+            f"{package_name}/cli.py": CliFiles._build_cli(package_name),
+            "tests/__init__.py": "",
+        }
+
+    @staticmethod
+    def _build_main() -> str:
+        return '''"""Run the generated command-line application as a module."""
+
+from .cli import main
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())
+'''
+
+    @staticmethod
+    def _build_cli(package_name: str) -> str:
+        return f'''"""Command-line interface for the generated application."""
+
+import argparse
+from collections.abc import Sequence
+
+
+APP_VERSION = "{_GENERATED_APP_VERSION}"
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog={package_name!r},
+        description="Minimal command-line application generated by ForgePy.",
+    )
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s {{APP_VERSION}}",
+    )
+    return parser
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    build_parser().parse_args(argv)
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())
+'''

templates/cli/cli_template.py

@@ -0,0 +1,55 @@
+from pathlib import Path
+
+from templates.cli.cli_files import CliFiles
+from templates.template_engine.file_template import FileTemplate
+from templates.template_engine.package_name import normalize_package_name
+from templates.template_engine.template_context import TemplateContext
+from templates.template_engine.template_metadata import TemplateMetadata
+
+
+class CliTemplate(FileTemplate):
+    """Generate a minimal standard-library command-line application."""
+
+    _METADATA = TemplateMetadata(
+        name="cli",
+        description="Minimal command-line application template.",
+        version="0.1.0",
+        author="Rendy Zou",
+        tags=("python", "cli", "argparse"),
+    )
+
+    _DEFAULT_VSCODE_ENTRY_POINT = None
+
+    def _build_context(
+        self,
+        project_path: Path,
+    ) -> TemplateContext:
+        return TemplateContext(
+            project_path=project_path,
+            package_name=self._normalize_package_name(project_path.name),
+        )
+
+    def _folders(self, context: TemplateContext) -> tuple[str, ...]:
+        return (
+            context.require_package_name(),
+            "tests",
+        )
+
+    def _files(self, context: TemplateContext) -> dict[str, str]:
+        return CliFiles.build(
+            project_name=context.project_name,
+            package_name=context.require_package_name(),
+        )
+
+    def _vscode_entry_point_for(
+        self,
+        context: TemplateContext,
+    ) -> str | None:
+        return f"{context.require_package_name()}/cli.py"
+
+    @staticmethod
+    def _normalize_package_name(project_name: str) -> str:
+        return normalize_package_name(
+            project_name,
+            package_label="CLI",
+        )

templates/env_template.py

@@ -0,0 +1,20 @@
+"""
+==================================================
+ForgePy
+Environment Template
+==================================================
+"""
+
+
+def get_env() -> str:
+    return """# Environment Variables
+
+DEBUG=True
+APP_NAME=MyApplication
+"""
+
+
+def get_env_example() -> str:
+    return """DEBUG=True
+APP_NAME=MyApplication
+"""

templates/gitignore_template.py

@@ -0,0 +1,27 @@
+"""
+==================================================
+ForgePy
+GitIgnore Template
+==================================================
+"""
+
+def get_gitignore() -> str:
+    return """__pycache__/
+*.pyc
+*.pyo
+*.pyd
+
+.venv/
+venv/
+
+.vscode/
+
+.env
+
+.idea/
+
+dist/
+build/
+
+*.log
+"""