Python API for Photoshop.
Project description
Python API for Photoshop.
The example above was created with Photoshop Python API.Check it out at
https://loonghao.github.io/photoshop-python-api/examples.
Has been tested and used Photoshop version:
|Photoshop Version||Supported|
|2023||✅|
|2022||✅|
|2021||✅|
|2020||✅|
|cc2019||✅|
|cc2018||✅|
|cc2017||✅|
Installing
You can install via pip.
pip install photoshop_python_api
Since it uses COM (Component Object Model) connect Photoshop, it can be used in any DCC software with a python interpreter.
Hello World
import photoshop.api as ps app = ps.Application() doc = app.documents.add() new_doc = doc.artLayers.add() text_color = ps.SolidColor() text_color.rgb.red = 0 text_color.rgb.green = 255 text_color.rgb.blue = 0 new_text_layer = new_doc new_text_layer.kind = ps.LayerKind.TextLayer new_text_layer.textItem.contents = ‘Hello, World!’ new_text_layer.textItem.position = [160, 167] new_text_layer.textItem.size = 40 new_text_layer.textItem.color = text_color options = ps.JPEGSaveOptions(quality=5) # # save to jpg jpg = ‘d:/hello_world.jpg’ doc.saveAs(jpg, options, asCopy=True) app.doJavaScript(f’alert(“save to jpg: {jpg}”)’)
Photoshop Session
Use it as context.
from photoshop import Session with Session(action=”new_document”) as ps: doc = ps.active_document text_color = ps.SolidColor() text_color.rgb.green = 255 new_text_layer = doc.artLayers.add() new_text_layer.kind = ps.LayerKind.TextLayer new_text_layer.textItem.contents = ‘Hello, World!’ new_text_layer.textItem.position = [160, 167] new_text_layer.textItem.size = 40 new_text_layer.textItem.color = text_color options = ps.JPEGSaveOptions(quality=5) jpg = ‘d:/hello_world.jpg’ doc.saveAs(jpg, options, asCopy=True) ps.app.doJavaScript(f’alert(“save to jpg: {jpg}”)’)
Contributors ✨
Thanks goes to these wonderful people (
emoji key):
|
|
Hal
💻
voodraizer
voodraizer
🐛
brunosly
brunosly
https://github.com/loonghao/photoshop-python-api/issues?q=author%3Abrunosly
tubi
tubi
https://github.com/loonghao/photoshop-python-api/issues?q=author%3Atubi-carrillo
wjxiehaixin
wjxiehaixin
https://github.com/loonghao/photoshop-python-api/issues?q=author%3Awjxiehaixin
罗马钟
罗马钟
https://github.com/loonghao/photoshop-python-api/issues?q=author%3Aenzozhong
clement
clement
https://github.com/loonghao/photoshop-python-api/issues?q=author%3AClementHector
krevlinmen
krevlinmen
https://github.com/loonghao/photoshop-python-api/issues?q=author%3Akrevlinmen
Thomas
Thomas
https://github.com/loonghao/photoshop-python-api/issues?q=author%3ASThomasN
CaptainCsaba
CaptainCsaba
https://github.com/loonghao/photoshop-python-api/issues?q=author%3ACaptainCsaba
Il Harper
Il Harper
https://github.com/loonghao/photoshop-python-api/commits?author=Afanyiyu
blunderedbishop
blunderedbishop
https://github.com/loonghao/photoshop-python-api/issues?q=author%3Ablunderedbishop
MrTeferi
MrTeferi
https://github.com/loonghao/photoshop-python-api/commits?author=MrTeferi
Damien Chambe
Damien Chambe
https://github.com/loonghao/photoshop-python-api/commits?author=damienchambe
Ehsan Akbari Tabar
Ehsan Akbari Tabar
https://github.com/loonghao/photoshop-python-api/issues?q=author%3Abe42day
Michael Ikemann
Michael Ikemann
https://github.com/loonghao/photoshop-python-api/issues?q=author%3AAlyxion
This project follows the
all-contributors specification.
Contributions of any kind are welcome!
Repobeats analytics
how to get Photoshop program ID
Get-ChildItem “HKLM:SOFTWAREClasses” | ?{ ($_.PSChildName -match “^[a-z]+.[a-z]+(.d+)?$”) -and ($_.GetSubKeyNames() -contains “CLSID”) } | ?{ $_.PSChildName -match “Photoshop.Application” } | ft PSChildName
How to get a list of COM objects from the registry
Useful links
https://theiviaxx.github.io/photoshop-docs/Photoshop/ http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/photoshop/pdfs/photoshop-cc-javascript-ref-2015.pdf https://github.com/lohriialo/photoshop-scripting-python https://www.adobe.com/devnet/photoshop/scripting.html https://www.youtube.com/playlist?list=PLUEniN8BpU8-Qmjyv3zyWaNvDYwJOJZ4m http://yearbook.github.io/esdocs/#/Photoshop/Application http://www.shining-lucy.com/wiki/page.php?id=appwiki:photoshop:ps_script http://www.tonton-pixel.com/wp-content/uploads/DecisionTable.pdf http://jongware.mit.edu/pscs5js_html/psjscs5/pc_Application.html https://indd.adobe.com/view/a0207571-ff5b-4bbf-a540-07079bd21d75 http://shining-lucy.com/wiki/page.php?id=appwiki:photoshop:ps_script http://web.archive.org/web/20140121053819/http://www.pcpix.com/Photoshop/char.html http://www.tonton-pixel.com/scripts/utility-scripts/get-equivalent-id-code/index.html https://github.com/Adobe-CEP/Samples/tree/master/PhotoshopEvents https://evanmccall.wordpress.com/2015/03/09/how-to-develop-photoshop-tools-in-python
Project details
Release history
[Release notifications](/help/#project-release-notifications) |
[RSS feed ](/rss/project/photoshop-python-api/releases.xml)
Download files
Download the file for your platform.If you’re not sure which to choose, learn more about
installing packages.
Source Distribution
Built Distribution
[Close](#modal-close) [Close](#modal-close)
Hashes for photoshop_python_api-0.21.2-py3-none-any.whl
|Algorithm||Hash digest|
|SHA256||
|
|MD5||
|
|BLAKE2b-256||
|.
