Skip to content

docs: add Python API quick example to README #394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrewhofmann wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Python API quick example to README #394

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,31 @@ prefix:
pip install git+https://github.com/Argmaster/pygerber
```

## 🚀 Quick Example

Render a Gerber file to PNG in a few lines:

```python
from pygerber.gerber.api import GerberFile

gerber = GerberFile.from_file("board-F_Cu.gbr")
image = gerber.render_with_pillow(dpmm=40)
image.save_png("front_copper.png")
```

Or try it immediately with a built-in example:

```python
from pygerber.gerber.api import GerberFile
from pygerber.examples import ExamplesEnum, get_example_path

gerber = GerberFile.from_file(get_example_path(ExamplesEnum.simple_2layer_F_Cu))
gerber.render_with_pillow(dpmm=40).save_png("output.png")
```

For multi-file rendering, custom color maps, SVG output, and more, see the
[Quick Start guide](https://argmaster.github.io/pygerber/stable/40_gerber/20_quick_start/00_introduction/).

## 📚 Documentation

PyGerber has online documentation hosted on GitHub Pages. It's a great starting point
Expand Down