@@ -22,10 +22,10 @@ json2python-models is a [Python](https://www.python.org/) tool that can generate
2222* Specifying when dictionaries should be processed as ** ` dict ` type** (by default every dict is considered as some model)
2323* ** CLI** tool
2424
25- ## Examples
25+ ## Example
2626[ * skip to ** Installation*** ] ( #installation )
2727
28- ``` json
28+ ```
2929[
3030 {
3131 "season": "2019",
@@ -55,30 +55,7 @@ json2python-models is a [Python](https://www.python.org/) tool that can generate
5555 }
5656 ]
5757 },
58- {
59- "position" : " 2" ,
60- "positionText" : " 2" ,
61- "points" : " 62" ,
62- "wins" : " 1" ,
63- "Driver" : {
64- "driverId" : " bottas" ,
65- "permanentNumber" : " 77" ,
66- "code" : " BOT" ,
67- "url" : " http://en.wikipedia.org/wiki/Valtteri_Bottas" ,
68- "givenName" : " Valtteri" ,
69- "familyName" : " Bottas" ,
70- "dateOfBirth" : " 1989-08-28" ,
71- "nationality" : " Finnish"
72- },
73- "Constructors" : [
74- {
75- "constructorId" : " mercedes" ,
76- "url" : " http://en.wikipedia.org/wiki/Mercedes-Benz_in_Formula_One" ,
77- "name" : " Mercedes" ,
78- "nationality" : " German"
79- }
80- ]
81- }
58+ ...
8259 ]
8360 }
8461]
@@ -129,9 +106,9 @@ class DriverStandings:
129106| ** Be ware** : this project supports only ` python3.7 ` and higher. |
130107| --- |
131108
132- To install Requests , use ` pip ` :
109+ To install it , use ` pip ` :
133110
134- ` pip install `
111+ ` pip install json2pytho-models `
135112
136113Or you can build it from source:
137114
@@ -153,12 +130,11 @@ python setup.py install
153130
154131## Tests
155132
156- To run tests you should clone project and install ` pytest ` and ` requests ` (to download online datasets) :
133+ To run tests you should clone project and run ` setup.py ` script :
157134
158135```
159136git clone https://github.com/bogdandm/json2python-models.git
160137cd json2python-models
161-
162138python setup.py test -a '<pytest additional arguments>'
163139```
164140
@@ -169,7 +145,7 @@ Also I would recommend you to install `pytest-sugar` for pretty printing test re
169145You can find out some examples of usage of this project at [ testing_tools/real_apis/...] ( /testing_tools/real_apis )
170146
171147Each file contains functions to download data from some online API (references included at the top of file) and
172- ` main ` function that generate and print code. Some examples may print debug data before actual code.
148+ ` main ` function that generates and prints code. Some examples may print debug data before actual code.
173149Downloaded data will be saved at ` testing_tools/real_apis/<name of example>/<dataset>.json `
174150
175151## API docs
0 commit comments