Metadata-Version: 2.1
Name: pinout
Version: 0.0.9
Summary: Generate graphical pinout references for electronic hardware.
Home-page: https://github.com/j0ono0/pinout
Author: John Newall
Author-email: john@johnnewall.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/j0ono0/pinout/issues
Description: # 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 pin-out diagrams for electronic hardware.
        
        <p align="center">
            <img alt="Example diagram created from pinout: micropython pin-out on Adafruit Huzzah32 ESP32 Feather Board." src="docs/_static/huzzah32_pinout.png" />
        </p>
        
        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 ultimately include an SVG file, an image of hardware to be documented, and a stylesheet that provides unique styles to the diagram. Duplicate the sample files from the *pinout* package by launch a command line at the location you intend to work and enter the following:
        ```python
        py -m pinout.file_manager --duplicate quick_start
        
        # expected output:
        # >>> quick_start_board.png duplicated.
        # >>> quick_start_config.yaml duplicated.
        # >>> quick_start_pinout.py duplicated.
        # >>> quick_start_styles.css duplicated.
        ```
        
        Once you have these file a finished diagram can be generated by running the python script from a command line `py quick_start_pinout.py`. An SVG file is created and can be conveniently view in a browser.
        
        ![SVG diagram ](docs/_static/quick_start_diagram.png)
        
        For a detailed walk through *sample_diagram.py* and more information on *pinout* please visit [pinout.readthedocs.io](https://pinout.readthedocs.io).
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
