Mercurial > odfcast > odfcast
annotate README.rst @ 78:b7e4f50c75ba
Add six != 1.9 to the requirements.
According to Björn, the version of six in Debigan wheezy is too old and
odfcast needs at least version 1.9.
For some reason it was missing from requirements.txt, so we add it now.
author | Bernhard Herzog <bh@intevation.de> |
---|---|
date | Wed, 25 Feb 2015 18:57:25 +0100 |
parents | 76838e53434c |
children | 77c3e481bea9 |
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 | 5 |
6 | |
7 Installation | |
8 ------------ | |
9 | |
38 | 10 To be able to convert odf documents an installed version of OpenOffice or |
11 LibreOffice is required for odfcast. Please take a look at the corresponding | |
12 website of Open-/LibreOffice how to install them on your system. | |
13 | |
25 | 14 Install requirements:: |
15 | |
16 $ pip install -r requirements.txt | |
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 |
5cef36a01574
Update README to explain configuration of the odfcase service
Björn Ricks <bjoern.ricks@intevation.de>
parents:
46
diff
changeset
|
27 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
|
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 | 31 Run |
32 --- | |
33 | |
34 Start server:: | |
35 | |
36 $ python main.py | |
37 | |
46 | 38 Open your webbrowser or use example clients:: |
25 | 39 |
40 $ ./castclient.py in.odt out.file -f format | |
41 | |
42 $ ./castclient.py in.odt out.file -f format --json data.json | |
43 | |
44 $ ./mergeclient.py in1.pdf in2.pdf in3.pdf -o out.pdf | |
45 | |
46 License | |
47 ------- | |
48 | |
49 MIT License |