Mercurial > odfcast

annotate README.rst @ 56:1e62ccffb395

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update setup.py and README.rst
author Björn Ricks <bjoern.ricks@intevation.de>
date Mon, 03 Nov 2014 15:25:19 +0100
parents 88a62b0ec3b1
children 76838e53434c
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
53
88a62b0ec3b1 Update README for py3o.template installation
Björn Ricks <bjoern.ricks@intevation.de>
parents: 51
diff changeset
14 Currently an unreleased version of py3o.template is required to work
88a62b0ec3b1 Update README for py3o.template installation
Björn Ricks <bjoern.ricks@intevation.de>
parents: 51
diff changeset
15 correctly::
88a62b0ec3b1 Update README for py3o.template installation
Björn Ricks <bjoern.ricks@intevation.de>
parents: 51
diff changeset
16
88a62b0ec3b1 Update README for py3o.template installation
Björn Ricks <bjoern.ricks@intevation.de>
parents: 51
diff changeset
17 $ hg clone https://bitbucket.org/faide/py3o.template
88a62b0ec3b1 Update README for py3o.template installation
Björn Ricks <bjoern.ricks@intevation.de>
parents: 51
diff changeset
18 $ pip install ./py3o.template
88a62b0ec3b1 Update README for py3o.template installation
Björn Ricks <bjoern.ricks@intevation.de>
parents: 51
diff changeset
19
25
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
20 Install requirements::
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
21
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
22 $ pip install -r requirements.txt
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
23
51
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
24 Configure
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
25 ---------
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
26
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
27 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
28 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
29
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
30 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
31 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
32
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
33 or host and port for the odfcase service::
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
34
5cef36a01574 Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents: 46
diff changeset
35 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
36
25
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
37 Run
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
38 ---
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 Start server::
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 $ python main.py
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
43
46
f270eaa7de8d Fix typo
Björn Ricks <bjoern.ricks@intevation.de>
parents: 45
diff changeset
44 Open your webbrowser or use example clients::
25
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 $ ./castclient.py in.odt out.file -f format
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 $ ./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
49
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
50 $ ./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
51
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
52 License
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
53 -------
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
54
0ce19505ef12 Update README
Björn Ricks <bjoern.ricks@intevation.de>
parents: 2
diff changeset
55 MIT License
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)