mockstack 0.3.0__tar.gz → 0.4.0__tar.gz

{mockstack-0.3.0/mockstack.egg-info → mockstack-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mockstack
-Version: 0.3.0
+Version: 0.4.0
 Summary: An API mocking workhorse
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/adamhadani/mockstack
@@ -47,7 +47,7 @@ Highlights include:
 
 Install using [uv](https://docs.astral.sh/uv/). This package conforms the concept of a [tool](https://docs.astral.sh/uv/concepts/tools/) and hence can simply install / run with `uvx`:
 
-    uvx mockstack
+    uvx mockstack --help
 
 or install into a persistent environment and add it to the PATH with:
 
@@ -56,15 +56,20 @@ or install into a persistent environment and add it to the PATH with:
 
 ## Usage
 
-Available configuration options are [here](https://github.com/adamhadani/mockstack/blob/main/mockstack/config.py). Setting individual options can be done with env. variables as in the following example:
+Available configuration options are [here](https://github.com/adamhadani/mockstack/blob/main/mockstack/config.py).
+
+Setting individual options can be done either through an `.env` file, individual environment variables, or command-line arguments. For example:
 
 ```shell
+    export MOCKSTACK__STRATEGY=filefixtures
     export MOCKSTACK__TEMPLATES_DIR=~/mockstack-templates/
     export MOCKSTACK__OPENTELEMETRY__ENABLED=true
     export MOCKSTACK__OPENTELEMETRY__CAPTURE_RESPONSE_BODY=true
-    uv run
+    uvx mockstack
 ```
 
+See also the included [.env.example](https://github.com/adamhadani/mockstack/blob/main/.env.example) for more examples. You can copy that file to `.env` and fill in configuration as needed based on the given examples.
+
 Out of the box, you get the following behavior when using the default `filefixtures` strategy:
 
 - The HTTP request `GET /someservice/api/v1/user/c27f5b2b-6e81-420d-a4e4-6426e1c32db8` will try to find `<templates_dir>/someservice-api-v1-user.c27f5b2b-6e81-420d-a4e4-6426e1c32db8.j2`,
@@ -97,8 +102,6 @@ If you are contributing to development, you will want to clone this project, and
     uv sync
     uv pip install -e .
 
-Copy the included [.env.example](https://github.com/adamhadani/mockstack/blob/main/.env.example) file to `.env` and fill in configuration as needed based on the given examples.
-
 Run in development mode (for live-reload of changes when developing):
 
-    uv run uvicorn --factory mockstack.main:create_app --reload
+    uv run -- mockstack --debug

{mockstack-0.3.0 → mockstack-0.4.0}/README.md

@@ -23,7 +23,7 @@ Highlights include:
 
 Install using [uv](https://docs.astral.sh/uv/). This package conforms the concept of a [tool](https://docs.astral.sh/uv/concepts/tools/) and hence can simply install / run with `uvx`:
 
-    uvx mockstack
+    uvx mockstack --help
 
 or install into a persistent environment and add it to the PATH with:
 
@@ -32,15 +32,20 @@ or install into a persistent environment and add it to the PATH with:
 
 ## Usage
 
-Available configuration options are [here](https://github.com/adamhadani/mockstack/blob/main/mockstack/config.py). Setting individual options can be done with env. variables as in the following example:
+Available configuration options are [here](https://github.com/adamhadani/mockstack/blob/main/mockstack/config.py).
+
+Setting individual options can be done either through an `.env` file, individual environment variables, or command-line arguments. For example:
 
 ```shell
+    export MOCKSTACK__STRATEGY=filefixtures
     export MOCKSTACK__TEMPLATES_DIR=~/mockstack-templates/
     export MOCKSTACK__OPENTELEMETRY__ENABLED=true
     export MOCKSTACK__OPENTELEMETRY__CAPTURE_RESPONSE_BODY=true
-    uv run
+    uvx mockstack
 ```
 
+See also the included [.env.example](https://github.com/adamhadani/mockstack/blob/main/.env.example) for more examples. You can copy that file to `.env` and fill in configuration as needed based on the given examples.
+
 Out of the box, you get the following behavior when using the default `filefixtures` strategy:
 
 - The HTTP request `GET /someservice/api/v1/user/c27f5b2b-6e81-420d-a4e4-6426e1c32db8` will try to find `<templates_dir>/someservice-api-v1-user.c27f5b2b-6e81-420d-a4e4-6426e1c32db8.j2`,
@@ -73,8 +78,6 @@ If you are contributing to development, you will want to clone this project, and
     uv sync
     uv pip install -e .
 
-Copy the included [.env.example](https://github.com/adamhadani/mockstack/blob/main/.env.example) file to `.env` and fill in configuration as needed based on the given examples.
-
 Run in development mode (for live-reload of changes when developing):
 
-    uv run uvicorn --factory mockstack.main:create_app --reload
+    uv run -- mockstack --debug

{mockstack-0.3.0 → mockstack-0.4.0}/mockstack/config.py

@@ -2,9 +2,19 @@ from functools import lru_cache
 from typing import Any, Literal, Self
 
 from pydantic import DirectoryPath, FilePath, model_validator
-from pydantic_settings import BaseSettings, SettingsConfigDict
+from pydantic_settings import (
+    BaseSettings,
+    CliImplicitFlag,
+    CliSuppress,
+    SettingsConfigDict,
+)
 
-from mockstack.constants import ProxyRulesRedirectVia
+from mockstack.constants import (
+    ENV_FILE,
+    ENV_NESTED_DELIMITER,
+    ENV_PREFIX,
+    ProxyRulesRedirectVia,
+)
 
 
 class OpenTelemetrySettings(BaseSettings):
@@ -28,11 +38,20 @@ class Settings(BaseSettings):
     """
 
     model_config = SettingsConfigDict(
-        env_prefix="mockstack__",
-        env_file=".env",
-        env_nested_delimiter="__",
+        env_prefix=ENV_PREFIX,
+        env_file=ENV_FILE,
+        env_nested_delimiter=ENV_NESTED_DELIMITER,
     )
 
+    # whether to run in debug mode
+    debug: CliImplicitFlag[bool] = False
+
+    # host to run the server on
+    host: str = "0.0.0.0"
+
+    # port to run the server on
+    port: int = 8000
+
     # OpenTelemetry configuration
     opentelemetry: OpenTelemetrySettings = OpenTelemetrySettings()
 
@@ -51,11 +70,11 @@ class Settings(BaseSettings):
 
     # controls behavior of proxying. Whether to simulate creation of resources
     # when a POST request is made to a resource that doesn't match any rules..
-    proxyrules_simulate_create_on_missing: bool = False
+    proxyrules_simulate_create_on_missing: CliImplicitFlag[bool] = False
 
     # metadata fields to inject into created resources.
     # A few template fields are available. See documentation for more details.
-    created_resource_metadata: dict[str, Any] = {
+    created_resource_metadata: CliSuppress[dict[str, Any]] = {
         "id": "{{ uuid4() }}",
         "createdAt": "{{ utcnow().isoformat() }}",
         "updatedAt": "{{ utcnow().isoformat() }}",
@@ -65,7 +84,7 @@ class Settings(BaseSettings):
 
     # fields to inject into missing resources response json.
     # some services may require such additional fields to be present in the response.
-    missing_resource_fields: dict[str, Any] = dict(
+    missing_resource_fields: CliSuppress[dict[str, Any]] = dict(
         code=404,
         message="mockstack: resource not found",
         retryable=False,
@@ -73,7 +92,7 @@ class Settings(BaseSettings):
 
     # logging configuration. schema is based on the logging configuration schema:
     # https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
-    logging: dict[str, Any] = {
+    logging: CliSuppress[dict[str, Any]] = {
         "version": 1,
         "disable_existing_loggers": False,
         "formatters": {
@@ -85,7 +104,7 @@ class Settings(BaseSettings):
         "handlers": {
             "console": {
                 "class": "logging.StreamHandler",
-                "level": "DEBUG",
+                "level": "INFO",
                 "formatter": "standard",
                 "stream": "ext://sys.stdout",
             },
@@ -93,23 +112,23 @@ class Settings(BaseSettings):
         "loggers": {
             "uvicorn": {
                 "handlers": ["console"],
-                "level": "INFO",
+                "level": "DEBUG",
                 "propagate": False,
             },
             "FileFixturesStrategy": {
                 "handlers": ["console"],
-                "level": "INFO",
+                "level": "DEBUG",
                 "propagate": False,
             },
             "ProxyRulesStrategy": {
                 "handlers": ["console"],
-                "level": "INFO",
+                "level": "DEBUG",
                 "propagate": False,
             },
         },
         "root": {
             "handlers": ["console"],
-            "level": "INFO",
+            "level": "DEBUG",
             "propagate": False,
         },
     }
@@ -135,6 +154,24 @@ class Settings(BaseSettings):
         return self
 
 
+# Nb. We separate the Cli-specific parameters since currently breaks pytest
+# when running via pre-commit hooks. Can remove once fixed by pytest / pre-commit.
+
+
+class CliSettings(Settings):
+    """Settings for mockstack CLI."""
+
+    model_config = SettingsConfigDict(
+        env_prefix=ENV_PREFIX,
+        env_file=ENV_FILE,
+        env_nested_delimiter=ENV_NESTED_DELIMITER,
+        cli_parse_args=True,
+        cli_kebab_case=True,
+        cli_hide_none_type=True,
+        cli_avoid_json=True,
+    )
+
+
 @lru_cache
 def settings_provider() -> Settings:
     """Provide the settings for the application."""

{mockstack-0.3.0 → mockstack-0.4.0}/mockstack/constants.py

@@ -2,7 +2,10 @@
 
 from enum import StrEnum
 
-# proxyrules strategy constants
+
+ENV_PREFIX = "mockstack__"
+ENV_FILE = ".env"
+ENV_NESTED_DELIMITER = "__"
 
 
 class ProxyRulesRedirectVia(StrEnum):

{mockstack-0.3.0 → mockstack-0.4.0}/mockstack/display.py

@@ -27,7 +27,8 @@ def announce(app: FastAPI, settings: Settings):
     logger = logging.getLogger("uvicorn")
     logger.info(
         f"{HIGHLIGHT}mockstack{ENDC} ready to roll. "
-        f"Using strategy: {HIGHLIGHT}{settings.strategy}{ENDC}, "
+        f"debug: {HIGHLIGHT}{settings.debug}{ENDC}. "
+        f"strategy: {HIGHLIGHT}{settings.strategy}{ENDC}. "
     )
     logger.info(str(app.state.strategy))
     logger.info(

{mockstack-0.3.0 → mockstack-0.4.0}/mockstack/lifespan.py

@@ -1,7 +1,7 @@
 """FastAPI application lifecycle management."""
 
 from contextlib import asynccontextmanager
-from logging import config
+from logging import DEBUG, config
 from typing import Callable
 
 from fastapi import FastAPI
@@ -21,7 +21,12 @@ def lifespan_provider(
 
         This is the context manager that FastAPI will use to manage the lifecycle of the application.
         """
+        if settings.debug:
+            # Enable verbose debug logging if debug mode is set.
+            settings.logging["handlers"]["console"]["level"] = DEBUG
+
         config.dictConfig(settings.logging)
+
         announce(app, settings)
 
         yield

{mockstack-0.3.0 → mockstack-0.4.0}/mockstack/main.py

@@ -1,9 +1,9 @@
 """Application entrypoints."""
 
 from fastapi import FastAPI
-from typer import Typer
+from pydantic_settings import CliApp, CliSettingsSource
 
-from mockstack.config import settings_provider
+from mockstack.config import CliSettings, Settings, settings_provider
 from mockstack.lifespan import lifespan_provider
 from mockstack.middleware import middleware_provider
 from mockstack.routers.catchall import catchall_router_provider
@@ -11,12 +11,10 @@ from mockstack.routers.homepage import homepage_router_provider
 from mockstack.strategies.factory import strategy_provider
 from mockstack.telemetry import opentelemetry_provider
 
-cli = Typer()
 
-
-def create_app() -> FastAPI:
-    """Create the FastAPI app."""
-    settings = settings_provider()
+def create_app(settings: Settings | None = None) -> FastAPI:
+    """Create the fastapi app and bootstrap all dependencies."""
+    settings = settings or settings_provider()
 
     app = FastAPI(lifespan=lifespan_provider(settings))
 
@@ -30,23 +28,23 @@ def create_app() -> FastAPI:
     return app
 
 
-@cli.command()
-def run(host: str = "0.0.0.0", port: int = 8000):
-    """mockstack run CLI entrypoint."""
+def run():
+    """run the mockstack server."""
+    import argparse
     import uvicorn
 
-    app = create_app()
-    uvicorn.run(app, host=host, port=port)
+    parser = argparse.ArgumentParser()
+    cli_settings = CliSettingsSource(CliSettings, root_parser=parser)
+    settings = CliApp.run(CliSettings, cli_settings_source=cli_settings)
+
+    app = create_app(settings=settings)
+
+    uvicorn.run(app, host=settings.host, port=settings.port)
 
 
-@cli.command()
 def version():
-    """mockstack version CLI entrypoint."""
+    """display mockstack version."""
     from importlib.metadata import version
 
     pkg_version = version("mockstack")
     print(f"mockstack {pkg_version}")
-
-
-if __name__ == "__main__":
-    cli()

{mockstack-0.3.0 → mockstack-0.4.0/mockstack.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mockstack
-Version: 0.3.0
+Version: 0.4.0
 Summary: An API mocking workhorse
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/adamhadani/mockstack
@@ -47,7 +47,7 @@ Highlights include:
 
 Install using [uv](https://docs.astral.sh/uv/). This package conforms the concept of a [tool](https://docs.astral.sh/uv/concepts/tools/) and hence can simply install / run with `uvx`:
 
-    uvx mockstack
+    uvx mockstack --help
 
 or install into a persistent environment and add it to the PATH with:
 
@@ -56,15 +56,20 @@ or install into a persistent environment and add it to the PATH with:
 
 ## Usage
 
-Available configuration options are [here](https://github.com/adamhadani/mockstack/blob/main/mockstack/config.py). Setting individual options can be done with env. variables as in the following example:
+Available configuration options are [here](https://github.com/adamhadani/mockstack/blob/main/mockstack/config.py).
+
+Setting individual options can be done either through an `.env` file, individual environment variables, or command-line arguments. For example:
 
 ```shell
+    export MOCKSTACK__STRATEGY=filefixtures
     export MOCKSTACK__TEMPLATES_DIR=~/mockstack-templates/
     export MOCKSTACK__OPENTELEMETRY__ENABLED=true
     export MOCKSTACK__OPENTELEMETRY__CAPTURE_RESPONSE_BODY=true
-    uv run
+    uvx mockstack
 ```
 
+See also the included [.env.example](https://github.com/adamhadani/mockstack/blob/main/.env.example) for more examples. You can copy that file to `.env` and fill in configuration as needed based on the given examples.
+
 Out of the box, you get the following behavior when using the default `filefixtures` strategy:
 
 - The HTTP request `GET /someservice/api/v1/user/c27f5b2b-6e81-420d-a4e4-6426e1c32db8` will try to find `<templates_dir>/someservice-api-v1-user.c27f5b2b-6e81-420d-a4e4-6426e1c32db8.j2`,
@@ -97,8 +102,6 @@ If you are contributing to development, you will want to clone this project, and
     uv sync
     uv pip install -e .
 
-Copy the included [.env.example](https://github.com/adamhadani/mockstack/blob/main/.env.example) file to `.env` and fill in configuration as needed based on the given examples.
-
 Run in development mode (for live-reload of changes when developing):
 
-    uv run uvicorn --factory mockstack.main:create_app --reload
+    uv run -- mockstack --debug

mockstack-0.4.0/mockstack.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mockstack = mockstack.main:run

{mockstack-0.3.0 → mockstack-0.4.0}/pyproject.toml

@@ -30,7 +30,7 @@ Homepage = "https://github.com/adamhadani/mockstack"
 Issues = "https://github.com/adamhadani/mockstack/issues"
 
 [project.scripts]
-mockstack = "mockstack.main:cli"
+mockstack = "mockstack.main:run"
 
 [dependency-groups]
 dev = [

mockstack-0.3.0/mockstack.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-mockstack = mockstack.main:cli