# photoshop-python-api **Repository Path**: open-instrument/photoshop-python-api ## Basic Information - **Project Name**: photoshop-python-api - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-02-07 - **Last Updated**: 2024-02-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README
[](#contributors-)
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. ```cmd 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 ----------- ```python 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. ```python 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](https://allcontributors.org/docs/en/emoji-key)):