Expose Types

Author: ParkerVR

README.md

@@ -157,17 +157,17 @@ The generated Python models have been packaged as a proper Python package in the
 From the cdk directory, install the models in editable mode:
 
 ```bash
-pip install -e ../api-model/python
+pip install -e file://$MODEL_CODE_PATH/python
 ```
 
 This creates an editable install that automatically reflects any changes made to the models without needing to reinstall.
 
-### 2. For Production/CI/CD
+### 2. Via GH
 
 Add this to your requirements.txt:
 
 ```
-git+https://github.com/Equal-IQ/api-model.git@main#subdirectory=python&egg=api_model
+git+https://$GITHUB_READ_TOKEN@github.com/Equal-IQ/api-model.git@main#subdirectory=python&egg=api_model
 ```
 
 ### Example Usage

python/api_model/__init__.py

@@ -1,2 +1,3 @@
 # Top-level package for EqualIQ API models
-__version__ = '0.1.0'
+__version__ = '0.1.0'
+from .types.models import *

python/api_model/types/__init__.py

@@ -1,3 +1,2 @@
 # Package for generated model types
-# Import common models for convenience
-from .models import PingResponseContent
+from .models import *

python/py.typed

@@ -18,4 +18,10 @@ dependencies = [
 "Homepage" = "https://github.com/equaliq/api-model"
 
 [tool.setuptools]
-packages = ["api_model", "api_model.types"]
+packages = ["api_model", "api_model.types"]
+
+[tool.setuptools.package-data]
+api_model = ["py.typed"]
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]