annotate README.rst @ 96:f6d87a17ed84 1.5.1

Require a newer version of py3o.template. Version 0.9.11 is newest one available at the moment. The issue we were having with some ODT templates might have been fixed in an earlier version (e.g. 0.9.9) but I've only tested it with 0.9.11.
author Bernhard Herzog <bh@intevation.de>
date Fri, 25 Aug 2017 18:36:44 +0200
parents 77c3e481bea9
children
rev   line source
2
745a53c8b4f2 Add a draft for a README
Björn Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
1 odfcast
745a53c8b4f2 Add a draft for a README
Björn Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
2 =======
745a53c8b4f2 Add a draft for a README
Björn Ricks <bjoern.ricks@intevation.de>
parents:
diff changeset
3
56
1e62ccffb395 Update setup.py and README.rst
Björn Ricks <bjoern.ricks@intevation.de>
parents: 53
diff changeset
4 A document conversion http service based on Open-/LibreOffice, py3o and PyPDF2
25
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
5
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
6
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
7 Installation
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
8 ------------
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
9
38
2f03f909d69c Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 27
diff changeset
10 To be able to convert odf documents an installed version of OpenOffice or
2f03f909d69c Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 27
diff changeset
11 LibreOffice is required for odfcast. Please take a look at the corresponding
2f03f909d69c Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 27
diff changeset
12 website of Open-/LibreOffice how to install them on your system.
2f03f909d69c Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 27
diff changeset
13
25
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
14 Install requirements::
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
15
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
16 $ pip install -r requirements.txt
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
17
51
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
18 Configure
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
19 ---------
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
20
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
21 To change the default settings create a odfcast/odfcast.ini file an overwrite
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
22 settings e.g. for py3o port and host::
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
23
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
24 PY3O_UNO_SERVER_HOSTNAME = "my.server.url"
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
25 PY3O_UNO_SERVER_PORT = 4001
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
26
72
77c3e481bea9 Minor typos corrected.
Bernhard Reiter <bernhard@intevation.de>
parents: 66
diff changeset
27 or host and port for the odfcast service::
51
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
28
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
29 SERVER_NAME = "my.odfcast.url:8500"
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
30
25
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
31 Run
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
32 ---
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
33
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
34 Start server::
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
35
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
36 $ python main.py
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
37
46
f270eaa7de8d Fix typo
Björn Ricks <bjoern.ricks@intevation.de>
parents: 45
diff changeset
38 Open your webbrowser or use example clients::
25
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
39
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
40 $ ./castclient.py in.odt out.file -f format
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
41
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
42 $ ./castclient.py in.odt out.file -f format --json data.json
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
43
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
44 $ ./mergeclient.py in1.pdf in2.pdf in3.pdf -o out.pdf
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
45
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
46 License
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
47 -------
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
48
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
49 MIT License
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)