SimpleIDML

https://github.com/starou/simpleidml
Admin
SimpleIDML is a Python library designed for manipulating Adobe InDesign IDML files, enabling the...
Tokens:3,660
Snippets:53
Trust Score:7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install SimpleIDML from source

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Build and install the SimpleIDML library from its source code.

```bash
python setup.py build
sudo python setup.py install
```

--------------------------------

### Install SimpleIDML using pip

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Install the SimpleIDML library using pip for easy integration into your Python projects.

```bash
pip install simpleidml
```

--------------------------------

### Configure FTP Parameters for Working Directory Access

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Provides an example of how to configure FTP parameters when the client accesses the working directory via FTP. This includes authentication, passive mode, and keep-alive settings.

```python
{
        'auth': ("ftp://ftp.foo.org", "user_account", "s3cret-pa55word"),
        'passive': False,
        'keepalive': True,         # False by default (optional)
        'keepalive_interval': 30,  # set socket.TCP_KEEPINTVL (optional)
        'keepalive_idle': 45,      # set socket.TCP_KEEPIDLE  (optional)
        'polite': False,           # Unilaterally close ftp connection (optional)
    }
```

--------------------------------

### Get New IDML Spreads

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Retrieves the list of spreads from a newly created IDML package after adding multiple pages.

```python
new_idml.spreads
```

--------------------------------

### Set up development environment

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Set up the development environment using Vagrant, SSH into the machine, navigate to the tests directory, and run the tests.

```bash
vagrant up
vagrant ssh
cd tests
python runtests.py
```

--------------------------------

### Prefixing IDML Package with Context Manager

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Demonstrates the correct way to use the prefix method with a 'with' statement to ensure proper file handling and avoid reference loss.

```python
from simple_idml import idml
my_doc = idml.IDMLPackage("/path/to/my_main_document.idml")
with my_doc.prefix("main") as f:
    # some code.
```

--------------------------------

### Combine Pages from Multiple IDML Documents

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Shows how to load multiple IDML files and prefix them to avoid reference collisions before combining their pages. Demonstrates accessing the number of pages in a prefixed document.

```python
edito_idml_file = IDMLPackage("magazineA-edito.idml")
courrier_idml_file = IDMLPackage("magazineA-courrier-des-lecteurs.idml")

# Always start by prefixing packages to avoid collision.
with edito_idml_file.prefix("edito") as p_edito,
     courrier_idml_file.prefix("courrier") as p_courrier:
    len(edito_idml_file.pages)
```

--------------------------------

### Explore IDML Package Structure

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Load an IDML package and inspect its contents, such as spreads and stories. The 'idml' module from 'simple_idml' is required.

```python
from simple_idml import idml
my_idml_package = idml.IDMLPackage("/path/to/my_main_document.idml")
my_idml_package.spreads
my_idml_package.stories
```

--------------------------------

### Print XML Structure

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Prints the XML structure of an IDML package after a page has been added.

```python
print etree.tostring(new_idml.xml_structure, pretty_print=True)
```

--------------------------------

### Insert IDML Content with Context Managers

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Inserts content from one IDML package into another at a specified XPath, using context managers for both packages and the insertion operation. Shows how to access stories and the resulting XML structure.

```python
from simple_idml import idml
idml_main = idml.IDMLPackage("/path/to/my_main_document.idml")
idml_module = idml.IDMLPackage("/path/to/my_small_document.idml")

with idml_main.prefix("main") as p_idml_main, \
     idml_module.prefix("article") as p_idml_article:

    with p_idml_main.insert_idml(p_idml_article, at="/Root/article[3]",
                                 only="/Root/module[1]") as f:
        f.stories
        print f.xml_structure_pretty()
```

--------------------------------

### Import PDF into IDML

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Imports a PDF file into an IDML package at a specified location. The 'crop' parameter controls how the PDF is cropped.

```python
with IDMLPackage("my_package.idml") as idml_file:
    with idml_file.import_pdf("file:/path/to/file.pdf", at="/Root/modules/module[2]", crop="PDFCrop") as f:
        f.export_xml()
```

--------------------------------

### Export InDesign File to Multiple Formats (PDF, JPEG, ZIP)

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Exports an InDesign file to multiple formats simultaneously, including PDF, JPEG, and a zipped InDesign Package. The responses are returned in the order specified.

```python
pdf_response, jpeg_response, zip_response = indesign.save_as(
                                    "/path_to_file.indd",
                                    [{"fmt": "pdf"}, {"fmt": "jpeg"}, {"fmt": "zip"}],
                                    "http://url-to-indesign-server:port",
                                    "/path/to/client/workdir",
                                    "/path/to/indesign-server/workdir")
```

--------------------------------

### Print Pretty XML Structure

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Prints the XML structure of an IDML package in a pretty-printed format. Useful for inspecting the document's XML hierarchy.

```python
from lxml import etree
print etree.tostring(my_package.xml_structure, pretty_print=True)
```

--------------------------------

### Add Multiple Pages from IDML

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Adds multiple pages from different IDML packages to a target IDML package. It uses a list of tuples, where each tuple contains the source package, page number, and XPath for insertion.

```python
edito_idml_file = IDMLPackage("magazineA-edito.idml")
courrier_idml_file = IDMLPackage("magazineA-courrier-des-lecteurs.idml")
bloc_notes_idml_file = IDMLPackage("magazineA-bloc-notes.idml")

with edito_idml_file.prefix("edito") as p_edito,
     courrier_idml_file.prefix("courrier") as p_courrier,
     bloc_notes_idml_file.prefix("blocnotes") as p_bloc_notes:

    packages_to_add = [
        (p_courrier, 1, "/Root", "/Root/page[1]"),
        (p_bloc_notes, 1, "/Root", "/Root/page[1]"),
    ]

    new_idml = p_edito.add_pages_from_idml(packages_to_add)
    len(new_idml.pages)
```

--------------------------------

### Add Page from IDML

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Adds a single page from one IDML package to another. It specifies the source and target packages, page number, and XPath for insertion.

```python
new_idml = p_edito.add_page_from_idml(p_courrier,
                                          page_number=1,
                                          at="/Root",
                                          only="/Root/page[1]")
len(new_idml.pages)
```

--------------------------------

### Export InDesign File to INDD Format

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Saves an InDesign file to the INDD format using the InDesign Server. Ensure the working directory is accessible by both client and server.

```python
from simple_idml.indesign import indesign

response = indesign.save_as("/path_to_file.idml", [{"fmt": "indd"}],
                                "http://url-to-indesign-server:port",
                                "/path/to/client/workdir",
                                "/path/to/indesign-server/workdir")[0]
with open("my_file.indd", "wb+") as f:
    f.write(response)
```

--------------------------------

### Export InDesign File to IDML Format

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Converts an InDesign file to the IDML format. This is useful for further editing or processing in other InDesign-compatible applications.

```python
response = indesign.save_as("/path_to_file.indd", [{"fmt": "idml"}],
                                "http://url-to-indesign-server:port",
                                "/path/to/client/workdir",
                                "/path/to/indesign-server/workdir")[0]
with open("my_file.idml", "wb+") as f:
    f.write(response)
```

--------------------------------

### Export IDML to XML

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Exports the content of an IDML package to an XML string. This is useful for inspecting or processing the IDML structure.

```python
idml_file = IDMLPackage("path/to/file.idml")
print idml_file.export_xml())
```

--------------------------------

### Access Font Families in IDML

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Retrieve font family elements from an IDML package and extract their 'Name' attributes. This assumes an 'lxml.etree' Element structure.

```python
my_package.font_families
[e.get("Name") for e in my_package.font_families]
```

--------------------------------

### Export InDesign File to PDF with CMYK Color Space

Source: https://github.com/starou/simpleidml/blob/master/README.rst

Exports an InDesign file to PDF format, specifying CMYK color space using the 'params' option. This is suitable for print production workflows.

```python
response = indesign.save_as("/path_to_file.indd", [
                                    {
                                    "fmt": "pdf",
                                    "params": {"colorSpace": "CMYK"},
                                    }],
                                "http://url-to-indesign-server:port",
                                "/path/to/client/workdir",
                                "/path/to/indesign-server/workdir")[0]
with open("my_file.pdf", "wb+") as f:
    f.write(response)
```
Tokens:
Raw