https://github.com/umar-ahmed/xdtools

An unofficial Python API for Adobe XD files. This library aims to allow developers to read and write to .xd files with ease.
https://github.com/umar-ahmed/xdtools

adobe-xd api artboards file-parser python xd-files

Last synced: 29 days ago
JSON representation

An unofficial Python API for Adobe XD files. This library aims to allow developers to read and write to .xd files with ease.

• Host: GitHub
• URL: https://github.com/umar-ahmed/xdtools
• Owner: umar-ahmed
• License: mit
• Created: 2017-04-04T23:10:45.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-08-25T13:47:14.000Z (about 5 years ago)
• Last Synced: 2024-10-02T08:41:58.510Z (about 1 month ago)
• Topics: adobe-xd, api, artboards, file-parser, python, xd-files
• Language: Python
• Homepage:
• Size: 346 KB
• Stars: 53
• Watchers: 11
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# XD Tools

**This is currently a WIP.** XD Tools is an unofficial Python API for Adobe XD. It provides the ability to parse and read data from `.xd` files that are created by Adobe XD using Python 3. As Adobe XD is constantly changing each month with new features, this API will inevitably change in order to stay up-to-date, so please report issues on GitHub if you find any.

## Installation

```

pip install xdtools

```

## Example Usage

### Printing the name of project

```python

from xdtools import XDFile

with XDFile('path/to/file.xd', 'r') as xd:

    print(xd.name)

```

### Printing the names of artboards

```python

from xdtools import XDFile

with XDFile('path/to/file.xd', 'r') as xd:

    for artboard in xd.artboards:

      print(artboard.name)

```

### Printing the color swatches

```python

from xdtools import XDFile

with XDFile('path/to/file.xd', 'r') as xd:

    for color_swatch in xd.color_swatches:

      print(color_swatch)

```

## Planned Features

### Read data from an XD file

* Project Name

* Fonts

* Colors

* Gradients

* Symbols

* Images

* Preview

* Artboards

  * Amount

  * Names

  * Dimensions

  * Position

  * Viewport Size

  * Artwork

    * Name

    * Type

    * Specific Attributes (eg. letter spacing, etc.)

    * Dimensions

    * Position

    * Stroke

    * Fill

    * Opacity

    * Filters

* Interactions

  * From

  * To

  * Transition

  * Duration

  * Easing