Mercurial > odfcast
annotate README.rst @ 62:16352bd395fa
Allow to ignore merge errors on files
Add a request param ignore_file_errors to allow skipping invalid pdf files
during merge.
| author | Björn Ricks <bjoern.ricks@intevation.de> |
|---|---|
| date | Wed, 12 Nov 2014 14:02:50 +0100 |
| parents | 1e62ccffb395 |
| 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 | 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 | |
|
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 | 20 Install requirements:: |
| 21 | |
| 22 $ pip install -r requirements.txt | |
| 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 | 37 Run |
| 38 --- | |
| 39 | |
| 40 Start server:: | |
| 41 | |
| 42 $ python main.py | |
| 43 | |
| 46 | 44 Open your webbrowser or use example clients:: |
| 25 | 45 |
| 46 $ ./castclient.py in.odt out.file -f format | |
| 47 | |
| 48 $ ./castclient.py in.odt out.file -f format --json data.json | |
| 49 | |
| 50 $ ./mergeclient.py in1.pdf in2.pdf in3.pdf -o out.pdf | |
| 51 | |
| 52 License | |
| 53 ------- | |
| 54 | |
| 55 MIT License |