1.0.3: Example usage in readme

Author: phillipdupuis

README.md

@@ -8,16 +8,75 @@ This tool requires that you have the lovely json2ts CLI utility installed. Instr
 ```bash
 $ pip install pydantic-to-typescript
 ```
+---
+### CLI
 
-### Command-line usage
+|Prop|Description|
+|:----------|:-----------|
+|`--module`|name of the python module you would like to convert. All the pydantic models within it will be converted to typescript interfaces. Discoverable submodules will also be checked. Ex: 'pydantic2ts.examples.pydantic_models'|
+|`--output`|name of the file the typescript definitions should be written to. Ex: './frontend/apiTypes.ts'|
+|<nobr>`--json2ts-cmd`</nobr>|optional, the command used to invoke json2ts. The default is 'json2ts'. Specify this if you have it installed in a strange location and need to provide the exact path (ex: /myproject/node_modules/bin/json2ts)|
+---
+### Usage
+pydantic2ts/examples/pydantic_models.py:
+```python
+from pydantic import BaseModel, Extra
+from enum import Enum
+from typing import List, Dict
 
-|Prop     |Description|
-|:--------|:-----------|
-|`--module` |name of the python module you would like to convert. All the pydantic models within it will be converted to typescript interfaces. Discoverable submodules will also be checked. Ex: 'pydantic2ts.examples.pydantic_models'|
-|`--output` |name of the file the typescript definitions should be written to. Ex: '/frontend/api-types.ts'|
-|`--json2ts-cmd` |optional, the command used to invoke json2ts. The default is 'json2ts'. Specify this if you have it installed in a strange location and need to provide the exact path (ex: /myproject/node_modules/bin/json2ts)|
 
-Example:
+class NoExtraProps:
+    extra = Extra.forbid
+
+
+class Sport(str, Enum):
+    football = 'football'
+    basketball = 'basketball'
+
+
+class Athlete(BaseModel):
+    name: str
+    age: int
+    sports: List[Sport]
+    Config = NoExtraProps
+
+
+class Team(BaseModel):
+    name: str
+    sport: Sport
+    athletes: List[Athlete]
+    Config = NoExtraProps
+
+
+class League(BaseModel):
+    cities: Dict[str, Team]
+    Config = NoExtraProps
+```
+Command-line:
 ```bash
 $ pydantic2ts --module pydantic2ts.examples.pydantic_models --output output.ts
 ```
+output.ts:
+```
+/* tslint:disable */
+/**
+/* This file was automatically generated from pydantic models by running pydantic2ts.
+/* Do not modify it by hand - just update the pydantic models and then re-run the script
+*/
+
+export interface Athlete {
+  name: string;
+  age: number;
+  sports: ("football" | "basketball")[];
+}
+export interface League {
+  cities: {
+    [k: string]: Team;
+  };
+}
+export interface Team {
+  name: string;
+  sport: "football" | "basketball";
+  athletes: Athlete[];
+}
+```

pydantic2ts/examples/output.ts

@@ -7,10 +7,15 @@
 export interface Athlete {
   name: string;
   age: number;
-  sports: ("football" | "basketball" | "running" | "swimming")[];
+  sports: ("football" | "basketball")[];
+}
+export interface League {
+  cities: {
+    [k: string]: Team;
+  };
 }
 export interface Team {
   name: string;
-  sport: "football" | "basketball" | "running" | "swimming";
+  sport: "football" | "basketball";
   athletes: Athlete[];
 }

pydantic2ts/examples/pydantic_models.py

@@ -1,28 +1,31 @@
 from pydantic import BaseModel, Extra
 from enum import Enum
-from typing import List
+from typing import List, Dict
 
 
-class NoUnspecifiedProps:
+class NoExtraProps:
     extra = Extra.forbid
 
 
 class Sport(str, Enum):
     football = 'football'
     basketball = 'basketball'
-    running = 'running'
-    swimming = 'swimming'
 
 
 class Athlete(BaseModel):
     name: str
     age: int
     sports: List[Sport]
-    Config = NoUnspecifiedProps
+    Config = NoExtraProps
 
 
 class Team(BaseModel):
     name: str
     sport: Sport
     athletes: List[Athlete]
-    Config = NoUnspecifiedProps
+    Config = NoExtraProps
+
+
+class League(BaseModel):
+    cities: Dict[str, Team]
+    Config = NoExtraProps

setup.py

@@ -20,7 +20,7 @@ def readme():
 
 setup(
     name='pydantic-to-typescript',
-    version='1.0.2',
+    version='1.0.3',
     description='Convert pydantic models to typescript interfaces',
     license='MIT',
     long_description=readme(),