Mercurial > odfcast
annotate README.rst @ 73:02efda1f6919
issue5117: service for checking a pdf for merging readiness added.
| author | Bernhard Reiter <bernhard@intevation.de> |
|---|---|
| date | Fri, 06 Mar 2015 14:56:26 +0100 |
| 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 | 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 |
|
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 | 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 |