README and update examples

bogdandm · bogdandm · commit 7a56a14b0811 · 2019-04-23T22:22:34.000+03:00
diff --git a/README.md b/README.md
@@ -22,10 +22,112 @@ json2python-models is a [Python](https://www.python.org/) tool that can generate
 * Specifying when dictionaries should be processed as is
 * CLI tool
 
+## Examples
+[*skip*](#installation)
+
+```json
+[
+    {
+        "season": "2019",
+        "round": "3",
+        "DriverStandings": [
+            {
+                "position": "1",
+                "positionText": "1",
+                "points": "68",
+                "wins": "2",
+                "Driver": {
+                    "driverId": "hamilton",
+                    "permanentNumber": "44",
+                    "code": "HAM",
+                    "url": "http://en.wikipedia.org/wiki/Lewis_Hamilton",
+                    "givenName": "Lewis",
+                    "familyName": "Hamilton",
+                    "dateOfBirth": "1985-01-07",
+                    "nationality": "British"
+                },
+                "Constructors": [
+                    {
+                        "constructorId": "mercedes",
+                        "url": "http://en.wikipedia.org/wiki/Mercedes-Benz_in_Formula_One",
+                        "name": "Mercedes",
+                        "nationality": "German"
+                    }
+                ]
+            },
+            {
+                "position": "2",
+                "positionText": "2",
+                "points": "62",
+                "wins": "1",
+                "Driver": {
+                    "driverId": "bottas",
+                    "permanentNumber": "77",
+                    "code": "BOT",
+                    "url": "http://en.wikipedia.org/wiki/Valtteri_Bottas",
+                    "givenName": "Valtteri",
+                    "familyName": "Bottas",
+                    "dateOfBirth": "1989-08-28",
+                    "nationality": "Finnish"
+                },
+                "Constructors": [
+                    {
+                        "constructorId": "mercedes",
+                        "url": "http://en.wikipedia.org/wiki/Mercedes-Benz_in_Formula_One",
+                        "name": "Mercedes",
+                        "nationality": "German"
+                    }
+                ]
+            }
+        ]
+    }
+]
+```
+
+```python
+import attr
+from json_to_models.dynamic_typing import IntString, IsoDateString
+from typing import List
+
+
+@attr.s
+class DriverStandings:
+    @attr.s
+    class DriverStanding:
+        @attr.s
+        class Driver:
+            driver_id: str = attr.ib()
+            permanent_number: IntString = attr.ib(converter=IntString)
+            code: str = attr.ib()
+            url: str = attr.ib()
+            given_name: str = attr.ib()
+            family_name: str = attr.ib()
+            date_of_birth: IsoDateString = attr.ib(converter=IsoDateString)
+            nationality: str = attr.ib()
+    
+        @attr.s
+        class Constructor:
+            constructor_id: str = attr.ib()
+            url: str = attr.ib()
+            name: str = attr.ib()
+            nationality: str = attr.ib()
+    
+        position: IntString = attr.ib(converter=IntString)
+        position_text: IntString = attr.ib(converter=IntString)
+        points: IntString = attr.ib(converter=IntString)
+        wins: IntString = attr.ib(converter=IntString)
+        driver: 'Driver' = attr.ib()
+        constructors: List['Constructor'] = attr.ib()
+
+    season: IntString = attr.ib(converter=IntString)
+    round: IntString = attr.ib(converter=IntString)
+    driver_standings: List['DriverStanding'] = attr.ib()
+```
+
 ## Installation
 
-| **Be ware**: it supports only `python3.7` and higher. |
-| --- |  
+| **Be ware**: this project supports only `python3.7` and higher. |
+| --- |
 
 To install Requests, use `pip`:
 
@@ -39,6 +141,15 @@ cd json2python-models
 python setup.py install
 ```
 
+## Usage
+
+### CLI
+
+> Coming soon
+
+### Low level
+
+> Coming soon (Wiki)
 
 ## Tests
 
@@ -47,19 +158,23 @@ To run tests you should clone project and install `pytest` and `requests` (to do
 ```
 git clone https://github.com/bogdandm/json2python-models.git
 cd json2python-models
-pip install pytest>=4.4.0
 
-python setup.py test -a '<pytest arguments>'
-or
-pytest tests
+python setup.py test -a '<pytest additional arguments>'
 ```
 
-Also I would recommend you to install `pytest-xdist` for parallel execution 
-and `pytest-sugar` for pretty printing test results
+Also I would recommend you to install `pytest-sugar` for pretty printing test results
 
 ### Test examples
 
-> 
+You can find out some examples of usage of this project at [testing_tools/real_apis/...](/testing_tools/real_apis)
+
+Each file contains functions to download data from some online API (references included at the top of file) and
+`main` function that generate and print code. Some examples may print debug data before actual code.
+Downloaded data will be saved at `testing_tools/real_apis/<name of example>/<dataset>.json`
+
+## API docs
+
+> Coming soon (Wiki)
 
 ## Built With
 
@@ -72,11 +187,12 @@ and `pytest-sugar` for pretty printing test results
 ## Contributing
 
 Feel free to open pull requests with new features or bug fixes. Just follow few rules:
+
 1. Always use some code formatter ([black](https://github.com/ambv/black) or PyCharm built-in)
 2. Keep code coverage above 95-98%
-3. All existing tests should be passed (including test examples)
+3. All existing tests should be passed (including test examples from `testing_tools/real_apis`)
 4. Use `typing` module
-5. Fix [codacy](https://app.codacy.com/project/bogdandm/json2python-models/dashboard) issues
+5. Fix [codacy](https://app.codacy.com/project/bogdandm/json2python-models/dashboard) issues from your PR
 
 ## License
 
diff --git a/etc/logo.png b/etc/logo.png
diff --git a/testing_tools/real_apis/f1.py b/testing_tools/real_apis/f1.py
@@ -11,7 +11,6 @@
 from json_to_models.models.attr import AttrsModelCodeGenerator
 from json_to_models.models.base import generate_code
 from json_to_models.registry import ModelRegistry
-from json_to_models.utils import json_format
 from testing_tools.pprint_meta_data import pretty_format_meta
 from testing_tools.real_apis import dump_response
 
@@ -58,8 +57,8 @@ def main():
         print("=" * 20, end='')
 
     structure = compose_models(reg.models_map)
-    print('\n', json_format([structure[0], {str(a): str(b) for a, b in structure[1].items()}]))
-    print("=" * 20)
+    # print('\n', json_format([structure[0], {str(a): str(b) for a, b in structure[1].items()}]))
+    # print("=" * 20)
 
     print(generate_code(structure, AttrsModelCodeGenerator))
 
diff --git a/testing_tools/real_apis/openlibrary.py b/testing_tools/real_apis/openlibrary.py
@@ -4,8 +4,10 @@
 import requests
 
 from json_to_models.generator import MetadataGenerator
+from json_to_models.models import compose_models
+from json_to_models.models.attr import AttrsModelCodeGenerator
+from json_to_models.models.base import generate_code
 from json_to_models.registry import ModelRegistry
-from testing_tools.pprint_meta_data import pretty_format_meta
 from testing_tools.real_apis import dump_response
 
 session = requests.Session()
@@ -44,16 +46,16 @@ def main():
 
     gen = MetadataGenerator()
     reg = ModelRegistry()
-    for data in (search_result, books):
-        reg.process_meta_data(gen.generate(*data))
+    reg.process_meta_data(gen.generate(*search_result), model_name="Search")
+    reg.process_meta_data(gen.generate(*books), model_name="Book")
     reg.merge_models(generator=gen)
 
-    print("\n" + "=" * 20, end='')
+    print("\n" + "=" * 20)
     for model in reg.models:
         model.generate_name()
-    for model in reg.models:
-        print(pretty_format_meta(model))
-        print("\n" + "=" * 20, end='')
+
+    structure = compose_models(reg.models_map)
+    print(generate_code(structure, AttrsModelCodeGenerator))
 
 
 if __name__ == '__main__':
diff --git a/testing_tools/real_apis/pathofexile.py b/testing_tools/real_apis/pathofexile.py
@@ -1,5 +1,5 @@
 """
-Path of Exile API http://www.pathofexile.com/developer/docs/api-resource-public-stash-tabs
+Path of Exile Stash API http://www.pathofexile.com/developer/docs/api-resource-public-stash-tabs
 """
 from datetime import datetime
 
@@ -10,7 +10,6 @@
 from json_to_models.models.attr import AttrsModelCodeGenerator
 from json_to_models.models.base import generate_code
 from json_to_models.registry import ModelRegistry
-from json_to_models.utils import json_format
 from testing_tools.pprint_meta_data import pretty_format_meta
 from testing_tools.real_apis import dump_response
 
@@ -34,12 +33,13 @@ def main():
     reg.merge_models(generator=gen)
     reg.generate_names()
 
+    print("Meta tree:")
     print(pretty_format_meta(next(iter(reg.models))))
     print("\n" + "=" * 20, end='')
 
     structure = compose_models_flat(reg.models_map)
-    print('\n', json_format([structure[0], {str(a): str(b) for a, b in structure[1].items()}]))
-    print("=" * 20)
+    # print('\n', json_format([structure[0], {str(a): str(b) for a, b in structure[1].items()}]))
+    # print("=" * 20)
 
     print(generate_code(structure, AttrsModelCodeGenerator))
     print(f"{(datetime.now() - start_t).total_seconds():.4f} seconds")
diff --git a/testing_tools/real_apis/randomapis.py b/testing_tools/real_apis/randomapis.py
@@ -39,11 +39,19 @@ def main():
 
     gen = MetadataGenerator()
     reg = ModelRegistry()
-    for data in ([chroniclingamerica_data], [launchlibrary_data], university_domains_data):
-        fields = gen.generate(*data)
-        reg.process_meta_data(fields)
+
+    fields = gen.generate(chroniclingamerica_data)
+    reg.process_meta_data(fields, model_name="CHRONICLING")
+
+    fields = gen.generate(launchlibrary_data)
+    reg.process_meta_data(fields, model_name="LaunchLibrary")
+
+    fields = gen.generate(*university_domains_data)
+    reg.process_meta_data(fields, model_name="Universities")
+
     reg.merge_models(generator=gen)
     reg.generate_names()
+
     structure = compose_models(reg.models_map)
     print(generate_code(structure, AttrsModelCodeGenerator))
 
