[FEAT] add & edit venv creation and apply deps at startup + startproject cli operations, edit templates

Author: bnbong

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "FastAPI-fastkit"
-version = "0.1.0"
+version = "0.1.1"
 description = "Fast, easy-to-use starter kit for new users of Python and FastAPI"
 authors = [
     {name = "bnbong", email = "bbbong9@gmail.com"},

src/fastapi_fastkit/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.1"
+__version__ = "0.1.1"
 
 import os
 

src/fastapi_fastkit/backend.py

@@ -5,6 +5,7 @@
 # --------------------------------------------------------------------------
 import os
 import re
+import subprocess
 from logging import getLogger
 from typing import Any
 
@@ -14,7 +15,7 @@
 from rich.table import Table
 from rich.text import Text
 
-from fastapi_fastkit.core.exceptions import TemplateExceptions
+from fastapi_fastkit.core.exceptions import BackendExceptions, TemplateExceptions
 
 from . import console
 
@@ -88,6 +89,7 @@ def inject_project_metadata(
     author_email: str,
     description: str,
 ) -> None:
+    # TODO : add main.py location at parameter
     """Inject project metadata."""
     try:
         main_py_path = os.path.join(target_dir, "main.py")
@@ -115,6 +117,51 @@ def inject_project_metadata(
         raise TemplateExceptions("Failed to inject metadata")
 
 
+def create_venv(project_dir: str) -> str:
+    """Create a virtual environment."""
+    try:
+        with console.status("[bold green]Setting up project environment..."):
+            console.print("[yellow]Creating virtual environment...[/yellow]")
+            venv_path = os.path.join(project_dir, ".venv")
+            subprocess.run(["python", "-m", "venv", venv_path], check=True)
+
+        if os.name == "nt":
+            activate_venv = f"    {os.path.join(venv_path, 'Scripts', 'activate.bat')}"
+        else:
+            activate_venv = f"    source {os.path.join(venv_path, 'bin', 'activate')}"
+            print_info(
+                "venv created at "
+                + venv_path
+                + "\nTo activate the virtual environment, run:\n\n"
+                + activate_venv,
+            )
+        return venv_path
+
+    except Exception as e:
+        print_error(f"Error during venv creation: {e}")
+        raise BackendExceptions("Failed to create venv")
+
+
+def install_dependencies(project_dir: str, venv_path: str) -> None:
+    """Install project dependencies in the virtual environment."""
+    try:
+        if os.name == "nt":  # Windows
+            pip_path = os.path.join(venv_path, "Scripts", "pip")
+        else:  # Linux/Mac
+            pip_path = os.path.join(venv_path, "bin", "pip")
+
+        with console.status("[bold green]Installing dependencies..."):
+            subprocess.run(
+                [pip_path, "install", "-r", "requirements.txt"],
+                cwd=project_dir,
+                check=True,
+            )
+
+    except Exception as e:
+        print_error(f"Error during dependency installation: {e}")
+        raise BackendExceptions("Failed to install dependencies")
+
+
 # TODO : modify this function
 # def read_template_stack() -> Union[list, None]:
 #     pass

src/fastapi_fastkit/cli.py

@@ -22,9 +22,10 @@
 from . import __version__, console
 from .backend import (
     create_info_table,
+    create_venv,
     inject_project_metadata,
+    install_dependencies,
     print_error,
-    print_info,
     print_success,
     print_warning,
     validate_email,
@@ -220,6 +221,9 @@ def startup(
             project_dir, project_name, author, author_email, description
         )
 
+        venv_path = create_venv(project_dir)
+        install_dependencies(project_dir, venv_path)
+
         print_success(
             f"FastAPI project '{project_name}' from '{template}' has been created and saved to {user_local}!"
         )
@@ -236,7 +240,7 @@ def startup(
 )
 def startproject(project_name: str) -> None:
     """
-    Start a new FastAPI project.
+    Start a empty FastAPI project setup.
     This command will automatically create a new FastAPI project directory and a python virtual environment.
     Dependencies will be automatically installed based on the selected stack at venv.
 
@@ -294,33 +298,11 @@ def startproject(project_name: str) -> None:
 
         console.print(table)
 
-        with console.status("[bold green]Setting up project environment..."):
-            console.print("[yellow]Creating virtual environment...[/yellow]")
-            venv_path = os.path.join(project_dir, "venv")
-            subprocess.run(["python", "-m", "venv", venv_path], check=True)
-
-            if os.name == "nt":  # Windows
-                pip_path = os.path.join(venv_path, "Scripts", "pip")
-            else:  # Linux/Mac
-                pip_path = os.path.join(venv_path, "bin", "pip")
-
-            console.print("[yellow]Installing dependencies...[/yellow]")
-            subprocess.run(
-                [pip_path, "install", "-r", "requirements.txt"],
-                cwd=project_dir,
-                check=True,
-            )
+        venv_path = create_venv(project_dir)
+        install_dependencies(project_dir, venv_path)
 
         print_success(f"Project '{project_name}' has been created successfully!")
 
-        if os.name == "nt":
-            activate_venv = f"    {os.path.join(venv_path, 'Scripts', 'activate.bat')}"
-        else:
-            activate_venv = f"    source {os.path.join(venv_path, 'bin', 'activate')}"
-        print_info(
-            "To activate the virtual environment, run:\n\n" + activate_venv,
-        )
-
     except Exception as e:
         print_error(f"Error during project creation: {e}")
         shutil.rmtree(project_dir, ignore_errors=True)
@@ -418,6 +400,7 @@ def runserver(
     reload: bool = True,
     workers: int = 1,
 ) -> None:
+    # TODO : check where main.py is located and run it
     """
     Run the FastAPI server for the current project.
     [1.1.0 update TODO] Alternative Point : using FastAPI-fastkit's 'fastapi dev' command

src/fastapi_fastkit/fastapi_project_template/fastapi-async-crud/.env.test-tpl

@@ -0,0 +1,3 @@
+# SECRET_KEY for testing (random string)
+SERVER_DOMAIN=localhost
+SECRET_KEY=jhnsavNAjHSMx0YBvL92wbM9K8FJEVDN

src/fastapi_fastkit/fastapi_project_template/fastapi-async-crud/.gitignore-tpl

@@ -0,0 +1,191 @@
+### venv template
+# Virtualenv
+# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
+.Python
+[Bb]in
+[Ii]nclude
+[Ll]ib
+[Ll]ib64
+[Ll]ocal
+[Ss]cripts
+pyvenv.cfg
+.venv
+pip-selfcheck.json
+
+### dotenv template
+.env
+
+### VirtualEnv template
+# Virtualenv
+# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
+.Python
+[Bb]in
+[Ii]nclude
+[Ll]ib
+[Ll]ib64
+[Ll]ocal
+pyvenv.cfg
+.venv
+pip-selfcheck.json
+
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/

src/fastapi_fastkit/fastapi_project_template/fastapi-async-crud/README.md-tpl

@@ -0,0 +1,17 @@
+# Simple FastAPI Project
+
+This is a test project using FastAPI. It is a RESTful API server with user management functionality.
+
+## Features
+
+- User Creation, Read, Update, Delete (CRUD) functionality
+- Automatic OpenAPI documentation generation (Swagger UI, ReDoc)
+- Custom exception handling
+- Test environment with mock data
+
+## Stack
+
+- Python 3.11+
+- FastAPI 0.111.1
+- Pydantic 2.8.2
+- pytest 8.2.2