Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/j0ono0/pinout

An open source Python package that generates hardware pinout diagrams as SVG images.
https://github.com/j0ono0/pinout

diagram electronics hardware python svg

Last synced: 2 months ago
JSON representation

An open source Python package that generates hardware pinout diagrams as SVG images.

Host: GitHub
URL: https://github.com/j0ono0/pinout
Owner: j0ono0
License: mit
Created: 2021-03-10T03:20:39.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2022-03-31T04:34:04.000Z (almost 3 years ago)
Last Synced: 2024-09-18T17:45:52.882Z (4 months ago)
Topics: diagram, electronics, hardware, python, svg
Language: Python
Homepage: https://pinout.readthedocs.io
Size: 3.46 MB
Stars: 376
Watchers: 8
Forks: 17
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-opensource-hardware - pinout

README

# pinout

![GitHub](https://img.shields.io/github/license/j0ono0/pinout) ![GitHub last commit](https://img.shields.io/github/last-commit/j0ono0/pinout) ![Read the Docs](https://img.shields.io/readthedocs/pinout)

SVG diagram creation from Python code - **pinout** provides an easy method of creating pinout diagrams for electronic hardware.

Example diagram created from pinout.

Please visit [pinout.readthedocs.io](https://pinout.readthedocs.io) for the full *quick start* tutorial and detailed documentation on all options provided by the *pinout* package.

## Quick start

*pinout* can be easily installed with pip and provides some sample files that demonstrate key features.

### Install

Using a virtual environment is recommended; Start by installing the *pinout* package. Either clone this repo and pip install it or install from PyPi:
```
pip install pinout

# Or upgrade to the latest version
pip install --upgrade pinout
```

### Duplicate sample files

A normal pinout diagram will include a hardware image, stylesheet, data file, and a Python script. Sample files are included with the package and can be duplicated for your use. Open a command line (with enabled virtual environment if you are using one) in the location you plan to work and enter the following:
```python
py -m pinout.manager --duplicate quick_start

# expected output:
# >>> data.py duplicated.
# >>> hardware.png duplicated.
# >>> pinout_diagram.py duplicated.
# >>> styles.css duplicated.
```

Once you have these file a finished diagram can be generated from a command line `py -m pinout.manager --export pinout_diagram diagram.svg`. An SVG file is created and can be conveniently view in a browser.

![SVG diagram ](docs/_static/quick_start_pinout_diagram.png)

For a detailed walk through *pinout_diagram.py* and more information on *pinout* please visit [pinout.readthedocs.io](https://pinout.readthedocs.io).