update build_examples script

This commit is contained in:
Andreas Nordin 2020-06-24 19:09:08 +02:00 committed by Daniel Rojas
parent 60cd069754
commit cdb2cf2b91
3 changed files with 22 additions and 62 deletions

View File

@ -36,6 +36,14 @@ pip3 install -e .
## 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
[WireViz input file](examples/demo01.yml):

View File

@ -1,50 +0,0 @@
import wireviz
import os
demos = 2 # 2
examples = 9 # 9
tutorials = 7 # 7
if demos:
for i in range(1,demos+1):
fn = '../examples/demo{:02d}.yml'.format(i)
print(fn)
wireviz.parse(fn, gen_bom=True)
if examples:
with open(os.path.abspath('../examples/readme.md'), 'w') as file:
file.write('# Example gallery\n')
for i in range(1,examples+1):
fn = '../examples/ex{:02d}.yml'.format(i)
print(fn)
wireviz.parse(fn, gen_bom=True)
file.write('## Example {:02d}\n'.format(i))
file.write('![](ex{:02d}.png)\n\n'.format(i))
file.write('[Source](ex{:02d}.yml) - [Bill of Materials](ex{:02d}.bom.tsv)\n\n\n'.format(i,i))
if tutorials:
with open(os.path.abspath('../tutorial/readme.md'), 'w') as file:
file.write('# WireViz Tutorial\n')
for i in range(1,tutorials+1):
fn = '../tutorial/tutorial{:02d}.yml'.format(i)
print(fn)
wireviz.parse(fn, gen_bom=True)
with open(os.path.abspath('../tutorial/tutorial{:02d}.md'.format(i)), 'r') as info:
for line in info:
file.write(line.replace('## ', '## {} - '.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:
file.write('```yaml\n')
for line in src:
file.write(line)
file.write('```\n')
file.write('\n')
file.write('\nOutput:\n\n'.format(i))
file.write('![](tutorial{:02d}.png)\n\n'.format(i))
file.write('[Bill of Materials](tutorial{:02d}.bom.tsv)\n\n\n'.format(i))

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

@ -1,25 +1,27 @@
import wireviz
#!/usr/bin/python3
import os
import sys
sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..'))
from wireviz import wireviz
demos = 2 # 2
<<<<<<< HEAD:src/wireviz/batch.py
examples = 9 # 9
=======
examples = 6 # 6
>>>>>>> 2d428e8... refactor dependencies and installation:src/wireviz/build_examples.py
tutorials = 7 # 7
if demos:
for i in range(1,demos+1):
fn = '../examples/demo{:02d}.yml'.format(i)
fn = '../../examples/demo{:02d}.yml'.format(i)
print(fn)
wireviz.parse(fn, gen_bom=True)
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')
for i in range(1,examples+1):
fn = '../examples/ex{:02d}.yml'.format(i)
fn = '../../examples/ex{:02d}.yml'.format(i)
print(fn)
wireviz.parse(fn, gen_bom=True)
@ -28,19 +30,19 @@ if examples:
file.write('[Source](ex{:02d}.yml) - [Bill of Materials](ex{:02d}.bom.tsv)\n\n\n'.format(i,i))
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')
for i in range(1,tutorials+1):
fn = '../tutorial/tutorial{:02d}.yml'.format(i)
fn = '../../tutorial/tutorial{:02d}.yml'.format(i)
print(fn)
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:
file.write(line.replace('## ', '## {} - '.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')
for line in src:
file.write(line)