Skip to content

wizofe/PhotoPie

Repository files navigation

Appveyor Status Codacy Badge Codestyle License: MPL 2.0 contributions welcome HitCount DOI Badge

PhotoPie

Python + Photoshop = 🧡

PhotoPie is an Adobe Photoshop© compatible library, tested with versions CC 2017/CC 2018 (but it should be able to work in previous versions as well), Windows 7 and 10 and Python 2.7, 3.5+. More like the missing Python API for your art needs!

Releasing

Planned ALPHA Release (0.1.0): June 2019. Keep the date.

Why?

Until today, Adobe offers only Javascript and Visual Basic Script (?!) for interfacing with Photoshop. Unfortunately both are not as easy to interface and widespread in the VFX/imaging world as much as Python. It was really frustrating to go myself through the bad documentation, describing some API calls, leaving a lot to be wished for.

That's why I decided to write PhotoPie! A user-friendly library, wrapping the Windows calls from Photoshop using comtypes.

As an example, to create a new

Development

Tools to be used in the development phase

  • Packaging: poetry
  • CI: Appveyor
  • Testing: pytest, tox
  • Documentation: sphinx, read the docs,
  • Coding Style: black
  • Contributing: poetry guidelines
  • Glue: dephell

References

In the scientific community and important element is the 'References' or stepping on the shoulders of giants. Nobody goes deep into the documentation and starts writing thousands of lines of code nowdays. That's why I am more than grateful, learning every day how to make my code better. Some blogs I got inspiration from:

FAQ

[Q.] I am running Mac, what can I do?

[A.] Unfortunately PhotoPie supports only Windows. The interface is quite straightforward though, so probably you would be more than able to port it on Mac using AppScript. Maybe that reference can also help.

[Q.] Why not to just use comtypes / win32com?

[A.] You can definitely do that. Actually that's how I started. I found out though that I had to create a lot of things from scratch and spends a few months just to discover basic functionality. That's why I decided to give back to the Open Source community an easier, more accessible (and hopefully) better documented way to do this! :)

The source code (inclusive) is licensed under the Mozilla Public License v 2.0 (see also the LICENSE file for more). Kindly asking for any citation in a paper, written work and publications, to be followed by the DOI, as seen in the badge in the beginning of the file. Specifically DOI:10.5281/zenodo.2949957. Thank you!

Adobe Photoshop© is a registered trademark of Adobe Systems Inc.