PcbDraw


NamePcbDraw JSON
Version 1.1.1 PyPI version JSON
download
home_pagehttps://github.com/yaqwsx/PcbDraw
SummaryUtility to produce nice looking drawings of KiCAD boards
upload_time2023-01-12 08:07:18
maintainer
docs_urlNone
authorJan Mrázek
requires_python>=3.7
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PcbDraw

Convert your KiCAD boards into nice looking 2D drawings suitable for pinout
diagrams. Never draw them manually again!

![example](promo_pcbdraw.png)

This tool takes a KiCAD board (.kicad_pcb file) and produces a 2D
nice looking drawing of the board as an SVG file. This allows you to quickly and
automatically create awesome pinout diagrams for your project. These diagrams
are much easier to read than a labeled photo of a physical board or an actual
KiCAD design.

You and your users will love them!

PcbDraw also comes with a small utility called Populate which allows you to
easily specify & maintain nice looking HTML or Markdown population manuals.

![example](promo_populate.jpg)

And, also, as a bonus it allows you to programmatically obtain 3D-rendered
previews of your boards (e.g., in CI).

## Installation

PcbDraw is a stand-alone CLI tool distributed as a Python package `pcbdraw`. It
also requires Inkscape 1 or librsvg installed. Read more details in the
[installation guide](doc/installation.md).

## Usage

There are two separate guides:

- [usage of PcbDraw](doc/pcbdraw.md)
- [usage of Populate](doc/populate.md)
- [library management tools](doc/library.md)

There are also examples of usage in the `examples` directory.

## PcbDraw seems to be broken!

Please, read [FAQ](doc/faq.md) first. If it does not answer your problem, feel
free to open issue on GitHub.


## Contributing

Feel free to submit issues and pull requests!

## Future Work

- make reasonably complete module library



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/yaqwsx/PcbDraw",
    "name": "PcbDraw",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Jan Mr\u00e1zek",
    "author_email": "email@honzamrazek.cz",
    "download_url": "https://files.pythonhosted.org/packages/9b/ed/9cb530cae30744dd275b6bd69a007c60c244b8b6f9e9116ceb35c79dd0e4/PcbDraw-1.1.1.tar.gz",
    "platform": null,
    "description": "# PcbDraw\n\nConvert your KiCAD boards into nice looking 2D drawings suitable for pinout\ndiagrams. Never draw them manually again!\n\n![example](promo_pcbdraw.png)\n\nThis tool takes a KiCAD board (.kicad_pcb file) and produces a 2D\nnice looking drawing of the board as an SVG file. This allows you to quickly and\nautomatically create awesome pinout diagrams for your project. These diagrams\nare much easier to read than a labeled photo of a physical board or an actual\nKiCAD design.\n\nYou and your users will love them!\n\nPcbDraw also comes with a small utility called Populate which allows you to\neasily specify & maintain nice looking HTML or Markdown population manuals.\n\n![example](promo_populate.jpg)\n\nAnd, also, as a bonus it allows you to programmatically obtain 3D-rendered\npreviews of your boards (e.g., in CI).\n\n## Installation\n\nPcbDraw is a stand-alone CLI tool distributed as a Python package `pcbdraw`. It\nalso requires Inkscape 1 or librsvg installed. Read more details in the\n[installation guide](doc/installation.md).\n\n## Usage\n\nThere are two separate guides:\n\n- [usage of PcbDraw](doc/pcbdraw.md)\n- [usage of Populate](doc/populate.md)\n- [library management tools](doc/library.md)\n\nThere are also examples of usage in the `examples` directory.\n\n## PcbDraw seems to be broken!\n\nPlease, read [FAQ](doc/faq.md) first. If it does not answer your problem, feel\nfree to open issue on GitHub.\n\n\n## Contributing\n\nFeel free to submit issues and pull requests!\n\n## Future Work\n\n- make reasonably complete module library\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Utility to produce nice looking drawings of KiCAD boards",
    "version": "1.1.1",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "148d151c7740a76b8e4062983657d763bbb017294cef4c9d942dd6d6473c2190",
                "md5": "031250d879c014fae67f19f1900814c1",
                "sha256": "13d3385f3e0efba2d3a56f5cd338bddb2f46bc31982a74af7f909538495fefce"
            },
            "downloads": -1,
            "filename": "PcbDraw-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "031250d879c014fae67f19f1900814c1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 1038024,
            "upload_time": "2023-01-12T08:07:16",
            "upload_time_iso_8601": "2023-01-12T08:07:16.256801Z",
            "url": "https://files.pythonhosted.org/packages/14/8d/151c7740a76b8e4062983657d763bbb017294cef4c9d942dd6d6473c2190/PcbDraw-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9bed9cb530cae30744dd275b6bd69a007c60c244b8b6f9e9116ceb35c79dd0e4",
                "md5": "f3595920e86f1bfb148b34404c8f8039",
                "sha256": "03f4f169f589dfcafcda6a0413cafa572414af7e61e52c3ecf1419c8ea29d97f"
            },
            "downloads": -1,
            "filename": "PcbDraw-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f3595920e86f1bfb148b34404c8f8039",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 312293,
            "upload_time": "2023-01-12T08:07:18",
            "upload_time_iso_8601": "2023-01-12T08:07:18.913502Z",
            "url": "https://files.pythonhosted.org/packages/9b/ed/9cb530cae30744dd275b6bd69a007c60c244b8b6f9e9116ceb35c79dd0e4/PcbDraw-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-12 08:07:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "yaqwsx",
    "github_project": "PcbDraw",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pcbdraw"
}
        
Elapsed time: 0.06681s