Mercurial > jouvence

comparison README.rst @ 13:ee741bbe96a8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Rename to 'Jouvence'.
author Ludovic Chabant <ludovic@chabant.com>
date Wed, 04 Jan 2017 09:02:29 -0800
parents 486c2349598e
children f21776c7fbfc
comparison
equal deleted inserted replaced
12:eea60b93da2c 13:ee741bbe96a8
1 1
2 ######## 2 ########
3 FONTAINE 3 JOUVENCE
4 ######## 4 ########
5 5
6 6
7 `Fountain`_ is a plain text markup language for screenwriting. Fontaine 7 `Fountain`_ is a plain text markup language for screenwriting. Jouvence
8 is a Python package for parsing and rendering Fountain documents. 8 is a Python package for parsing and rendering Fountain documents.
9 9
10 Fontaine supports: 10 Jouvence supports:
11 11
12 * Most of the Fountain specification (see limitations below). 12 * Most of the Fountain specification (see limitations below).
13 * Rendering to HTML and terminals. 13 * Rendering to HTML and terminals.
14 14
15 .. _fountain: http://fountain.io/ 15 .. _fountain: http://fountain.io/
17 17
18 Installation 18 Installation
19 ============ 19 ============
20 20
21 As with many Python packages, it's recommended that you use `virtualenv`_, 21 As with many Python packages, it's recommended that you use `virtualenv`_,
22 but since Fontaine doesn't have many dependencies, you should be fine. 22 but since Jouvence doesn't have many dependencies, you should be fine.
23 23
24 You can install Fontaine the usual way:: 24 You can install Jouvence the usual way::
25 25
26 pip install fontaine 26 pip install jouvence
27 27
28 If you want to test that it works, you can feed it a Fountain screenplay and 28 If you want to test that it works, you can feed it a Fountain screenplay and
29 see if it prints it nicely in your terminal:: 29 see if it prints it nicely in your terminal::
30 30
31 fontaine <path-to-fountain-file> 31 jouvence <path-to-fountain-file>
32 32
33 You should then see the Fountain file rendered with colored and indented 33 You should then see the Fountain file rendered with colored and indented
34 styles. 34 styles.
35 35
36 .. _virtualenv: https://virtualenv.pypa.io/en/stable/ 36 .. _virtualenv: https://virtualenv.pypa.io/en/stable/
37 37
38 38
39 Usage 39 Usage
40 ===== 40 =====
41 41
42 The Fontaine API goes pretty much like this:: 42 The Jouvence API goes pretty much like this::
43 43
44 from fontaine.parser import FontaineParser 44 from jouvence.parser import JouvenceParser
45 from fontaine.html import HtmlDocumentRenderer 45 from jouvence.html import HtmlDocumentRenderer
46 46
47 parser = FontaineParser() 47 parser = JouvenceParser()
48 document = parser.parse(path_to_file) 48 document = parser.parse(path_to_file)
49 renderer = HtmlDocumentRenderer() 49 renderer = HtmlDocumentRenderer()
50 markup = renderer.render_doc(document) 50 markup = renderer.render_doc(document)
51 return markup 51 return markup
52 52
53 53
54 Limitations 54 Limitations
55 =========== 55 ===========
56 56
57 Fontaine doesn't support the complete Fountain syntax yet. The following things 57 Jouvence doesn't support the complete Fountain syntax yet. The following things
58 are not implemented yet: 58 are not implemented yet:
59 59
60 * Dual dialogue 60 * Dual dialogue
61 * Notes 61 * Notes
62 * Boneyards 62 * Boneyards