README.md 1.19 KB
Newer Older
Etienne Nadji's avatar
Etienne Nadji committed
1
2
# PyScribus

Etienne Nadji's avatar
Etienne Nadji committed
3
**Branche principale, >= Python 3.8** | 
Etienne Nadji's avatar
Etienne Nadji committed
4
5
6
7
**Main branch, >= Python 3.8**

Une librairie Python pour manipuler (et documenter) 
le format de Scribus, le SLA.
Etienne Nadji's avatar
Etienne Nadji committed
8

Etienne Nadji's avatar
Etienne Nadji committed
9
10
11
12
13
14
15
## Obtenir PyScribus

```bash
pip3 install pyscribus
```

### Pré-requis
Etienne Nadji's avatar
Etienne Nadji committed
16
17

- [lxml](https://lxml.de/)
Etienne Nadji's avatar
Etienne Nadji committed
18
- [svg.path](https://pypi.org/project/svg.path/)
19
20
- [Pillow](https://python-pillow.org/), optionnel, pour le module ``extra.wireframe``

Etienne Nadji's avatar
Etienne Nadji committed
21
#### Debian / Ubuntu
22

Etienne Nadji's avatar
Etienne Nadji committed
23
```bash
24
sudo apt install python3 python3-lxml
Etienne Nadji's avatar
Etienne Nadji committed
25
sudo pip3 install svg.path
26
```
Etienne Nadji's avatar
Etienne Nadji committed
27

Etienne Nadji's avatar
Etienne Nadji committed
28
29
## Documentation

Etienne Nadji's avatar
Etienne Nadji committed
30
31
[La documentation](https://etnadji.fr/pyscribus) est générée 
via Sphinx, avec le thème *Read the Docs*.
Etienne Nadji's avatar
Etienne Nadji committed
32

Etienne Nadji's avatar
Etienne Nadji committed
33
34
35
36
37
38
39
```bash
make sphinxdoc
```

### Pré-requis

#### Debian / Ubuntu
40

Etienne Nadji's avatar
Etienne Nadji committed
41
```bash
Etienne Nadji's avatar
Etienne Nadji committed
42
43
44
sudo apt install python3-sphinx python3-sphinx-rtd-theme
```

Etienne Nadji's avatar
Etienne Nadji committed
45
46
47
48
49
50
51
52
## Documentation externe

### Le format SLA

[File Format Specification for Scribus 1.5](https://wiki.scribus.net/canvas/File_Format_Specification_for_Scribus_1.5)

- [Liste des elements/attributs documentables](source/articles/en/spec.rst) trouvés lors de l’écriture de cette librairie.

Etienne Nadji's avatar
Etienne Nadji committed
53
54
55
56
57
58
59
## Avancement

- [ ] **en cours** Analyse (*parsing*) totale
  - [ ] Objets Python cohérents
  - [ ] Import et export XML
- [ ] Fonctions de haut niveau