Mercurial > jouvence

annotate README.rst @ 35:6fb4d60b1e23 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag 0.4.0 for changeset 093bf35461ba
author Ludovic Chabant <ludovic@chabant.com>
date Tue, 17 Jan 2017 09:18:54 -0800
parents 9ae14e9615e6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
1
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
2 ########
13
ee741bbe96a8 Rename to 'Jouvence'.
Ludovic Chabant <ludovic@chabant.com>
parents: 6
diff changeset
3 JOUVENCE
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
4 ########
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
5
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
6
13
ee741bbe96a8 Rename to 'Jouvence'.
Ludovic Chabant <ludovic@chabant.com>
parents: 6
diff changeset
7 `Fountain`_ is a plain text markup language for screenwriting. Jouvence
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
8 is a Python package for parsing and rendering Fountain documents.
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
9
13
ee741bbe96a8 Rename to 'Jouvence'.
Ludovic Chabant <ludovic@chabant.com>
parents: 6
diff changeset
10 Jouvence supports:
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
11
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
12 * Most of the Fountain specification (see limitations below).
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
13 * Rendering to HTML and terminals.
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
14
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
15 .. _fountain: http://fountain.io/
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
16
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
17
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
18 Installation
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
19 ============
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
20
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
21 As with many Python packages, it's recommended that you use `virtualenv`_,
13
ee741bbe96a8 Rename to 'Jouvence'.
Ludovic Chabant <ludovic@chabant.com>
parents: 6
diff changeset
22 but since Jouvence doesn't have many dependencies, you should be fine.
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
23
13
ee741bbe96a8 Rename to 'Jouvence'.
Ludovic Chabant <ludovic@chabant.com>
parents: 6
diff changeset
24 You can install Jouvence the usual way::
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
25
13
ee741bbe96a8 Rename to 'Jouvence'.
Ludovic Chabant <ludovic@chabant.com>
parents: 6
diff changeset
26 pip install jouvence
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
27
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
28 If you want to test that it works, you can feed it a Fountain screenplay and
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
29 see if it prints it nicely in your terminal::
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
30
13
ee741bbe96a8 Rename to 'Jouvence'.
Ludovic Chabant <ludovic@chabant.com>
parents: 6
diff changeset
31 jouvence <path-to-fountain-file>
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
32
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
33 You should then see the Fountain file rendered with colored and indented
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
34 styles.
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
35
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
36 .. _virtualenv: https://virtualenv.pypa.io/en/stable/
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
37
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
38
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
39 Usage
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
40 =====
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
41
13
ee741bbe96a8 Rename to 'Jouvence'.
Ludovic Chabant <ludovic@chabant.com>
parents: 6
diff changeset
42 The Jouvence API goes pretty much like this::
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
43
13
ee741bbe96a8 Rename to 'Jouvence'.
Ludovic Chabant <ludovic@chabant.com>
parents: 6
diff changeset
44 from jouvence.parser import JouvenceParser
ee741bbe96a8 Rename to 'Jouvence'.
Ludovic Chabant <ludovic@chabant.com>
parents: 6
diff changeset
45 from jouvence.html import HtmlDocumentRenderer
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
46
13
ee741bbe96a8 Rename to 'Jouvence'.
Ludovic Chabant <ludovic@chabant.com>
parents: 6
diff changeset
47 parser = JouvenceParser()
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
48 document = parser.parse(path_to_file)
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
49 renderer = HtmlDocumentRenderer()
20
f21776c7fbfc Fix API usage in README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 13
diff changeset
50 with open(path_to_output, 'w') as fp:
f21776c7fbfc Fix API usage in README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 13
diff changeset
51 renderer.render_doc(document, fp)
f21776c7fbfc Fix API usage in README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 13
diff changeset
52
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
53
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
54
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
55 Limitations
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
56 ===========
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
57
13
ee741bbe96a8 Rename to 'Jouvence'.
Ludovic Chabant <ludovic@chabant.com>
parents: 6
diff changeset
58 Jouvence doesn't support the complete Fountain syntax yet. The following things
31
9ae14e9615e6 docs: Add Sphynx documentation and code docstrings.
Ludovic Chabant <ludovic@chabant.com>
parents: 24
diff changeset
59 are not implemented:
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
60
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
61 * Dual dialogue
22
142a53d6e558 Add support for notes.
Ludovic Chabant <ludovic@chabant.com>
parents: 20
diff changeset
62 * Proper Unicode support (although Fountain's spec greatly assumes English screenplays, sadly).
6
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
63
486c2349598e Add README, LICENSE, and requirements files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
64