update build_examples script

This commit is contained in:
Andreas Nordin 2020-06-24 19:09:08 +02:00
parent 869454ce58
commit 2834392e6b
2 changed files with 22 additions and 8 deletions

View File

@ -36,6 +36,14 @@ pip3 install -e .
## Examples ## Examples
### (re)building the example projects
If you would like to rebuild all of the included demos, examples and tutorials, use the ```build_examples.py``` script:
```cd src/wireviz
./build_examples.py
```
### Demo 01 ### Demo 01
[WireViz input file](examples/demo01.yml): [WireViz input file](examples/demo01.yml):

22
src/wireviz/build_examples.py Normal file → Executable file
View File

@ -1,5 +1,11 @@
import wireviz #!/usr/bin/python3
import os import os
import sys
sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..'))
from wireviz import wireviz
demos = 2 # 2 demos = 2 # 2
examples = 6 # 6 examples = 6 # 6
@ -7,15 +13,15 @@ tutorials = 7 # 7
if demos: if demos:
for i in range(1,demos+1): for i in range(1,demos+1):
fn = '../examples/demo{:02d}.yml'.format(i) fn = '../../examples/demo{:02d}.yml'.format(i)
print(fn) print(fn)
wireviz.parse(fn, gen_bom=True) wireviz.parse(fn, gen_bom=True)
if examples: if examples:
with open(os.path.abspath('../examples/readme.md'), 'w') as file: with open(os.path.abspath('../../examples/readme.md'), 'w') as file:
file.write('# Example gallery\n') file.write('# Example gallery\n')
for i in range(1,examples+1): for i in range(1,examples+1):
fn = '../examples/ex{:02d}.yml'.format(i) fn = '../../examples/ex{:02d}.yml'.format(i)
print(fn) print(fn)
wireviz.parse(fn, gen_bom=True) wireviz.parse(fn, gen_bom=True)
@ -24,19 +30,19 @@ if examples:
file.write('[Source](ex{:02d}.yml) - [Bill of Materials](ex{:02d}.bom.tsv)\n\n\n'.format(i,i)) file.write('[Source](ex{:02d}.yml) - [Bill of Materials](ex{:02d}.bom.tsv)\n\n\n'.format(i,i))
if tutorials: if tutorials:
with open(os.path.abspath('../tutorial/readme.md'), 'w') as file: with open(os.path.abspath('../../tutorial/readme.md'), 'w') as file:
file.write('# WireViz Tutorial\n') file.write('# WireViz Tutorial\n')
for i in range(1,tutorials+1): for i in range(1,tutorials+1):
fn = '../tutorial/tutorial{:02d}.yml'.format(i) fn = '../../tutorial/tutorial{:02d}.yml'.format(i)
print(fn) print(fn)
wireviz.parse(fn, gen_bom=True) wireviz.parse(fn, gen_bom=True)
with open(os.path.abspath('../tutorial/tutorial{:02d}.md'.format(i)), 'r') as info: with open(os.path.abspath('../../tutorial/tutorial{:02d}.md'.format(i)), 'r') as info:
for line in info: for line in info:
file.write(line.replace('## ', '## {} - '.format(i))) file.write(line.replace('## ', '## {} - '.format(i)))
file.write('\n[Source](tutorial{:02d}.yml):\n\n'.format(i)) file.write('\n[Source](tutorial{:02d}.yml):\n\n'.format(i))
with open(os.path.abspath('../tutorial/tutorial{:02d}.yml'.format(i)), 'r') as src: with open(os.path.abspath('../../tutorial/tutorial{:02d}.yml'.format(i)), 'r') as src:
file.write('```yaml\n') file.write('```yaml\n')
for line in src: for line in src:
file.write(line) file.write(line)