MockupEngineer

A simple library for creating beautiful screenshots.

## Navigation * [Example](https://github.com/ulbwazhine/MockupEngineer#example) * [Install](https://github.com/ulbwazhine/MockupEngineer#install) * [Update](https://github.com/ulbwazhine/MockupEngineer#update) * [Usage](https://github.com/ulbwazhine/MockupEngineer#usage) * [As a standalone application](https://github.com/ulbwazhine/MockupEngineer#as-a-standalone-application) * [In Python console](https://github.com/ulbwazhine/MockupEngineer#in-python-console) * [MockupEngineerInstance.generate parameters](https://github.com/ulbwazhine/MockupEngineer#mockupengineerinstancegenerate-parameters) * [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) ## Example
Apple iPhone 12 Pro Max Mockup

Apple iPhone 12 Pro Max Mockup

### Notice The quality of all examples is much worse than real mockups, this is due to the project size limit on PyPI. ## Install ```console $ python3 -m pip install MockupEngineer ``` ### Update ```console $ python3 -m pip install MockupEngineer --upgrade ``` ## Usage #### As a standalone application: ```console $ python3 -m MockupEngineer ```
Usage as a standalone application
#### In Python console: ```python from MockupEngineer import MockupEngineerInstance mockup = MockupEngineerInstance() mockup.generate(template_id=mockup.templates[0].id, screenshot_path='/path/to/screenshot', color=mockup.templates[0].colors[0].color) ``` ```console >>> /path/to/mockup ``` #### `MockupEngineerInstance.generate` parameters: * `template_id`: *int* — Device template id, 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) ## List of supported mockups Full list of all currently supported mockups {% for a, b in templates.items() %} ### {{b.title}} {% for c in b.templates %} * [{{c.manufacturer}} {{c.name}}](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupEngineer/templates/{{os.path.basename(os.path.dirname(c.preview))}}/preview.png) ({{c.year}}) [{{c.resolution}}] * Author: [@{{c.about.author}}]({{c.about.url}}) [{{c.about.created}}] * ID: `{{c.id}}` * Colors: {% for d in c.colors %} * * *{{d.color}}* {% endfor %}{% endfor %}{% endfor %} You can help the project by adding support for new mockups by contributing on [GitHub](https://github.com/ulbwazhine/MockupEngineer). ## Links [](https://ulbwa.github.io) [](https://github.com/ulbwazhine/MockupEngineer) [](https://pypi.org/project/MockupEngineer) [](https://ulbwa.github.io/go?to=donate)