Skip to content

Commit 021a6cb

Browse files
gferonboxdot
authored andcommitted
Add more instructions on how to run inspector from source and add a symlink (#141)
Signed-off-by: Gabriel Féron <feron.gabriel@gmail.com>
1 parent 67aed3f commit 021a6cb

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

flatdata-py/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,16 @@ flatdata-generator --gen python --schema locations.flatdata --output-file locati
1717

1818
`flatdata-py` comes with a handy tool called the `flatdata-inspector` to inspect the contents of an archive:
1919

20+
* from the `flatdata-py` source directory:
21+
22+
```sh
23+
./inspector.py
24+
# or
25+
python3 -m flatdata.lib.inspector
26+
```
27+
28+
* if you want to install `flatdata-py`:
29+
2030
```sh
2131
pip3 install flatdata-py[inspector] # the inspector feature requires IPython
2232
flatdata-inspector -p /path/to/my/flatdata.archive

flatdata-py/inspector.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/usr/bin/env python3
2+
from flatdata.lib import inspector
3+
inspector.main()

inspector

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
./flatdata-py/inspector.py

0 commit comments

Comments
 (0)