Skip to content

Latest commit

 

History

History
147 lines (110 loc) · 2.76 KB

README.md

File metadata and controls

147 lines (110 loc) · 2.76 KB
Raw

script-skeleton

What's this?

A little helper for creating skeleton of scripts with hierarchy, to be filled later with content.

It generates something like this:

page1
    pan1
        sq1:

    pan2 - Nothing Here!
    pan3
        sq1
            part1:

            part2:

            sidenote1:

        sfx1:

    pan4
        sfx1:

        b1:

        b2:

        sfx2:

    pan5
        b1:

        sfx1:

Just by giving this:

BFS-ish mode:
"""5pan:
sq
0
sq(2part sidenote) sfx
sfx 2b sfx
b sfx"""

or this:

DFS-ish mode:
"""pan(sq)
pan(0)
pan(sq(2part sidenote) sfx)
pan(sfx 2b sfx)
pan(b sfx)"""

How to use

Clone this repository and install.

$ git clone https://github.com/marrcio/script-skeleton

$ cd script-skeleton
$ python setup.py install
OR
$ pip install ./script-skeleton/

$ ipython
from scriptskeleton import ScriptSkeleton

Give it a sring that resembles identifier number identifier number. Very forgiving, don't worry.

Example: "page1 page36", "block 3 block 50", "from the token 37 to the token66"

This will specify the name of the first level blocks and the number of them.

>>> ss = ScriptSkeleton('page1 page36')

Now for every block created (e.g. 36 pages) feed it with internal blocks.

  • There are two possible ways of feeding: BFS-ish and DFS-ish.
  • For BFS-ish behaviour, give it a NUMBER, ID and end the line with':'. With this, the next NUMBER lines will specify what to give to blocks of ID.
  • For DFS-ish behaviour, give it NUMBER ID PARENTHESIS. Anything inside parenthesis will be a son of the current element.
  • For an empty element, put a line with a single 0

Illustrating this:

>>> ss.feed("""5pan:
sq
0
sq(2part sidenote) sfx
sfx 2b sfx
b sfx""")

Means, in order of lines:

  • In the current block, create 5 'pan' which will be described in the next five lines.
  • on pan1, attach a 'sq' element.
  • on pan2, don't attach anything.
  • on pan3, attach a 'sq' which is father of 2 'part' element and a 'sidenode' and a 'sfx'
  • on pan4, attach a 'sfx', then 2 'b' then another 'sfx'
  • on pan5, attach a 'b' then a 'sfx'

Running this would create the first example structure.

Repeating this process will create all subsequent blocks. You can check the status at any time:

>>> ss.status()

And also, you can always check the preview of an specific block:

>>> ss.preview()   # The last completed block
>>> ss.preview(3)  # The block with number 3 it its name.

Once done, everything can be saved to a 'filename.txt' with:

ss.to_file('filename.txt')

Templating

An alternative to doing incremental work is writing all the changes in a file and run it with

$ python template.py

or

$ ipython
>>> %run template.py
>>> ss.preview() # or ss.status() or anything else.