mostlyai-mock 0.2.1__tar.gz → 0.2.2__tar.gz

{mostlyai_mock-0.2.1 → mostlyai_mock-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mostlyai-mock
-Version: 0.2.1
+Version: 0.2.2
 Summary: Synthetic Mock Data
 Project-URL: homepage, https://github.com/mostly-ai/mostlyai-mock
 Project-URL: repository, https://github.com/mostly-ai/mostlyai-mock

{mostlyai_mock-0.2.1 → mostlyai_mock-0.2.2}/mostlyai/mock/__init__.py

@@ -15,4 +15,4 @@
 from mostlyai.mock.core import sample
 
 __all__ = ["sample"]
-__version__ = "0.2.1"  # Do not set this manually. Use poetry version [params].
+__version__ = "0.2.2"  # Do not set this manually. Use poetry version [params].

{mostlyai_mock-0.2.1 → mostlyai_mock-0.2.2}/mostlyai/mock/core.py

@@ -1334,6 +1334,7 @@ def sample(
         tables (dict[str, dict]): The table specifications to generate mock data for. See examples for usage.
             Note: Avoid using double quotes (`"`) and other special characters in column names.
             Available dtypes: `string`, `integer`, `float`, `category`, `boolean`, `date`, `datetime`.
+            Primary key dtypes: `integer` → auto-increment (1, 2, 3, ...); `string` → LLM-generated unique IDs.
         sample_size (int | dict[str, int]): The number of rows to generate for each subject table.
             If a single integer is provided, the same number of rows will be generated for each subject table.
             If a dictionary is provided, the number of rows to generate for each subject table can be specified individually.
@@ -1458,6 +1459,32 @@ def sample(
     df_items = data["items"]
     ```
 
+    Example of auto-increment integer primary keys (self-referencing table):
+    ```python
+    from mostlyai import mock
+
+    tables = {
+        "employees": {
+            "prompt": "Employees of a company",
+            "columns": {
+                "employee_id": {"dtype": "integer"},  # integer PK → auto-increment (1, 2, 3, ...)
+                "name": {"prompt": "first name and last name of the employee", "dtype": "string"},
+                "boss_id": {"dtype": "integer"},  # integer FK → references auto-incremented values
+                "role": {"prompt": "the role of the employee", "dtype": "string"},
+            },
+            "primary_key": "employee_id",
+            "foreign_keys": [
+                {
+                    "column": "boss_id",
+                    "referenced_table": "employees",
+                    "prompt": "each boss has at most 3 employees",
+                },
+            ],
+        }
+    }
+    df = mock.sample(tables=tables, sample_size=10, model="openai/gpt-5", n_workers=1)
+    ```
+
     Example of enriching a single dataframe:
     ```python
     from mostlyai import mock

{mostlyai_mock-0.2.1 → mostlyai_mock-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mostlyai-mock"
-version = "0.2.1"
+version = "0.2.2"
 description = "Synthetic Mock Data"
 authors = [{ name = "MOSTLY AI", email = "dev@mostly.ai" }]
 requires-python = ">=3.10"