2022-01-22 11:26:39 +03:00
< div align = "center" >
< h1 > MockupEngineer< / h1 >
2022-01-23 12:06:02 +03:00
< p >
< img src = "https://img.shields.io/pypi/dm/MockupEngineer" >
< img src = "https://img.shields.io/pypi/v/MockupEngineer?label=version" >
< img src = "https://img.shields.io/pypi/l/MockupEngineer" >
< img src = "https://img.shields.io/github/repo-size/ulbwazhine/MockupEngineer" >
< / p >
2022-01-25 14:34:25 +03:00
< p > A simple library for creating beautiful screenshots.< / p >
2022-01-22 11:42:24 +03:00
< / div >
2022-01-23 12:09:23 +03:00
## Navigation
2022-01-23 12:13:18 +03:00
* [Example ](https://github.com/ulbwazhine/MockupEngineer#example )
* [Install ](https://github.com/ulbwazhine/MockupEngineer#install )
2022-01-25 14:32:04 +03:00
* [Update ](https://github.com/ulbwazhine/MockupEngineer#update )
2022-01-23 12:13:18 +03:00
* [Usage ](https://github.com/ulbwazhine/MockupEngineer#usage )
* [As a standalone application ](https://github.com/ulbwazhine/MockupEngineer#as-a-standalone-application )
2022-01-25 13:41:02 +03:00
* [In Python console ](https://github.com/ulbwazhine/MockupEngineer#in-python-console )
2022-01-25 13:42:35 +03:00
* [MockupEngineerInstance.generate parameters ](https://github.com/ulbwazhine/MockupEngineer#mockupengineerinstancegenerate-parameters )
2022-01-23 12:13:18 +03:00
* [List of supported mockups ](https://github.com/ulbwazhine/MockupEngineer#list-of-supported-mockups )
* [Phones ](https://github.com/ulbwazhine/MockupEngineer#phones )
* [Tablets ](https://github.com/ulbwazhine/MockupEngineer#tablets )
* [Computers ](https://github.com/ulbwazhine/MockupEngineer#computers )
* [Wearable devices ](https://github.com/ulbwazhine/MockupEngineer#wearable-devices )
* [Links ](https://github.com/ulbwazhine/MockupEngineer#links )
2022-01-23 12:09:23 +03:00
2022-01-22 11:42:24 +03:00
## Example
2022-01-23 11:52:10 +03:00
< div align = "center" >
2022-01-24 16:21:06 +03:00
< img width = "375px" src = "https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/iphone12promax/example.png" alt = "Apple iPhone 12 Pro Max Mockup" >
2022-01-23 11:52:10 +03:00
< p > Apple iPhone 12 Pro Max Mockup< / p >
< / div >
2022-01-22 12:07:17 +03:00
## Install
2022-01-24 16:37:07 +03:00
```console
$ python3 -m pip install MockupEngineer
2022-01-22 12:07:17 +03:00
```
2022-01-25 14:32:04 +03:00
### Update
```console
$ python3 -m pip install MockupEngineer --upgrade
```
2022-01-22 11:42:24 +03:00
## Usage
2022-01-25 13:41:02 +03:00
#### As a standalone application:
```console
$ python3 -m MockupEngineer
```
2022-01-31 11:01:06 +03:00
< div align = "center" >
< img width = "70%" src = "https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/console_example.jpeg" alt = "" >
< / div >
2022-01-23 12:10:56 +03:00
#### In Python console:
2022-01-23 17:06:12 +03:00
2022-01-22 11:42:24 +03:00
```python
2022-01-23 17:06:12 +03:00
from MockupEngineer import MockupEngineerInstance
2022-01-22 11:42:24 +03:00
2022-01-23 17:06:12 +03:00
mockup = MockupEngineerInstance()
2022-01-22 11:42:24 +03:00
2022-01-23 17:06:12 +03:00
mockup.generate(template=mockup.templates[0],
2022-01-22 11:42:24 +03:00
screenshot_path='/path/to/screenshot',
color=mockup.templates[0].colors[0].color)
```
2022-01-24 16:35:18 +03:00
```console
2022-01-22 11:42:24 +03:00
>>> /path/to/mockup
```
2022-01-25 14:37:12 +03:00
#### `MockupEngineerInstance.generate` parameters:
2022-01-25 13:41:02 +03:00
* `template` : *Template* — Device template model, must be passed from *MockupEngineerInstance.templates* or *MockupEngineerInstance.get_templates()* .
* `screenshot_path` : *str* — Absolute path to the image in **JPG, PNG format** .
* `color` : *Optional[str]* — Optional parameter, force device color. Must be passed according to *Template.colors[* *n**].color*
* `orientation` : *str* — Optional parameter, force device orientation. Must be *landscape* or *portrait* .
* `external_storage` : *Optional[bool]* — Optional parameter, true if you need to upload mockup on [TemporaryStorage ](https://github.com/ulbwazhine/TemporaryStorage ) (0x0.st etc)
2022-01-22 11:42:24 +03:00
2022-01-23 11:52:10 +03:00
## List of supported mockups
Full list of all currently supported mockups
### Phones
2022-01-23 17:11:22 +03:00
* [Samsung Galaxy S20 ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/galaxys20/example.png ) [1440 x 3200] (2020)
2022-01-23 11:52:10 +03:00
* Cloud Blue
* Cosmic Grey
* Pink
2022-01-23 17:11:22 +03:00
* [Samsung Galaxy S20 Ultra ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/galaxys20/example.png ) [1440 x 3200] (2020)
2022-01-23 11:52:10 +03:00
* Cosmic Black
* Cosmic Grey
2022-01-23 17:11:22 +03:00
* [Apple iPhone 12 ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/iphone12/example.png ) [1170 x 2532] (2020)
2022-01-23 11:52:10 +03:00
* Black
* Blue
* Green
* PRODUCT RED
* White
2022-01-23 17:11:22 +03:00
* [Apple iPhone 12 Mini ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/iphone12mini/example.png ) [1080 x 2340] (2020)
2022-01-23 11:52:10 +03:00
* Black
* Blue
* Green
* PRODUCT RED
* White
2022-01-23 17:11:22 +03:00
* [Apple iPhone 12 Pro ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/iphone12pro/example.png ) [1170 x 2532] (2020)
2022-01-23 11:52:10 +03:00
* Gold
* Graphite
* Pacific Blue
* Silver
2022-01-23 17:11:22 +03:00
* [Apple iPhone 12 Pro Max ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/iphone12promax/example.png ) [1284 x 2778] (2020)
2022-01-23 11:52:10 +03:00
* Gold
* Graphite
* Pacific Blue
* Silver
2022-01-23 17:11:22 +03:00
* [Apple iPhone SE ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/iphonese2020/example.png ) [750 x 1334] (2020)
2022-01-23 11:52:10 +03:00
* Black
* PRODUCT RED
* White
2022-01-23 17:11:22 +03:00
* [Apple iPhone Xr ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/iphonexr/example.png ) [828 x 1792] (2018)
2022-01-23 11:52:10 +03:00
* Blue
* Coral
* PRODUCT RED
* Silver
* Space Gray
* Yellow
2022-01-23 17:11:22 +03:00
* [Google Pixel ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/pixel/example.png ) [1080 x 1920] (2016)
2022-01-23 11:52:10 +03:00
* Quite Black
* Really Blue
* Very Silver
2022-01-23 17:11:22 +03:00
* [Google Pixel 4 ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/pixel4/example.png ) [1080 x 2280] (2019)
2022-01-23 11:52:10 +03:00
* Clearly White
* Just Black
* Oh So Orange
2022-01-23 17:11:22 +03:00
* [Google Pixel 4 XL ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/pixel4xl/example.png ) [1440 x 3040] (2019)
2022-01-23 11:52:10 +03:00
* Clearly White
* Just Black
* Oh So Orange
2022-01-23 17:11:22 +03:00
* [Google Pixel 5 ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/pixel5/example.png ) [1080 x 2340] (2020)
2022-01-23 11:52:10 +03:00
* Just Black
* Sorta Sage
2022-01-25 14:27:41 +03:00
### Computers
* [Apple iMac 21" ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/imac212015/example.png ) [4096 x 2304] (2015)
* Silver
2022-01-30 18:34:14 +03:00
* [Apple iMac 24" ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/imac242021/example.png ) [4480 x 2520] (2021)
* Blue
* Green
* Orange
* Pink
* Purple
* Silver
* Yellow
2022-01-25 14:27:41 +03:00
* [Apple MacBook 12" ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/macbook122016/example.png ) [2304 x 1440] (2016)
* Gold
* Space Gray
* [Apple MacBook Pro 13" ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/macbookpro132015/example.png ) [2560 x 1600] (2015)
* Silver
* [Apple MacBook Pro 15" ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/macbookpro152015/example.png ) [2880 x 1800] (2015)
* Silver
2022-01-23 11:52:10 +03:00
### Tablets
2022-01-23 17:11:22 +03:00
* [Apple iPad 9 ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/ipad9/example.png ) [2160 x 1620] (2021)
2022-01-23 11:52:10 +03:00
* Gold
* Silver
* Space Gray
2022-01-23 17:11:22 +03:00
* [Apple iPad Air 4 ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/ipadair4/example.png ) [2360 x 1640] (2020)
2022-01-23 11:52:10 +03:00
* Green
* Rose Gold
* Silver
* Sky Blue
* Space Gray
2022-01-23 17:11:22 +03:00
* [Apple iPad Mini 5 ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/ipadmini5/example.png ) [2048 x 1536] (2021)
2022-01-23 11:52:10 +03:00
* Gold
* Silver
* Space Gray
2022-01-23 17:11:22 +03:00
* [Apple iPad Pro 4 11" ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/ipadpro114/example.png ) [2388 x 1668] (2020)
2022-01-23 11:52:10 +03:00
* Silver
* Space Gray
2022-01-23 17:11:22 +03:00
* [Apple iPad Pro 4 12.9" ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/ipadpro134/example.png ) [2732 x 2048] (2020)
2022-01-23 11:52:10 +03:00
* Silver
* Space Gray
### Wearable devices
2022-01-23 17:11:22 +03:00
* [Apple Watch Series 6 44mm ](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/watchseries644mm/example.png ) [368 x 448] (2020)
2022-01-23 11:52:10 +03:00
* Aluminum Case - Blue
* Aluminum Case - Gold
* Aluminum Case - PRODUCT RED
* Aluminum Case - Silver
* Aluminum Case - Space Gray
* Stainless Steel Case - Gold
* Stainless Steel Case - Graphite
* Stainless Steel Case - Silver
* Titanium Case - Dark
* Titanium Case - Light
You can help the project by adding support for new mockups by contributing on [GitHub ](https://github.com/ulbwazhine/MockupEngineer ).
2022-01-22 11:42:24 +03:00
## Links
2022-01-25 11:31:48 +03:00
[<img src="https://raw.githubusercontent.com/ulbwa/ulbwa/main/static/badges/author.svg" height="30"/> ](https://ulbwa.github.io )
[<img src="https://raw.githubusercontent.com/ulbwa/ulbwa/main/static/badges/github.svg" height="30"/> ](https://github.com/ulbwazhine/MockupEngineer )
[<img src="https://raw.githubusercontent.com/ulbwa/ulbwa/main/static/badges/pypi.svg" height="30"/> ](https://pypi.org/project/MockupEngineer )
[<img src="https://raw.githubusercontent.com/ulbwa/ulbwa/main/static/badges/donate.svg" height="30"/> ](https://ulbwa.github.io/go?to=donate )
