InteractiveHtmlBom


NameInteractiveHtmlBom JSON
Version 2.9.0 PyPI version JSON
download
home_page
SummaryGenerate Interactive Html BOM for your electronics projects
upload_time2024-02-23 19:35:53
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords eagle easyeda kicad ibom
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Interactive HTML BOM plugin for KiCad
## Supports EasyEDA, Eagle, Fusion360 and Allegro PCB designer

![icon](https://i.imgur.com/js4kDOn.png)

This plugin generates a convenient Bill of Materials (BOM) listing with the
ability to visually correlate and easily search for components and their placements
on the PCB. It is particularly useful when hand-soldering a prototype, as it allows
users to quickly find locations of components groups on the board. It is also possible
to reverse lookup the component group by clicking on a footprint on the board drawing.

The plugin utilizes Pcbnew python API to read PCB data and render silkscreen, fab layer,
footprint pads, text, and drawings. BOM table fields and grouping is fully configurable,
additional columns, such as a manufacturer ID, can be added in Schematic editor and
imported either through the netlist file, XML file generated by Eeschema's internal
BOM tool, or from board file itself.

There is an option to include tracks/zones data as well as netlist information allowing
dynamic highlight of nets on the board.

For full description of functionality see [wiki](https://github.com/openscopeproject/InteractiveHtmlBom/wiki).

Generated html page is fully self contained, doesn't need internet connection to work
and can be packaged with documentation of your project or hosted anywhere on the web.

[A demo is worth a thousand words.](https://openscopeproject.org/InteractiveHtmlBomDemo/)

## Installation and Usage

See [project wiki](https://github.com/openscopeproject/InteractiveHtmlBom/wiki/Installation) for instructions.

## License and credits

Plugin code is licensed under MIT license, see `LICENSE` for more info.

Html page uses [Split.js](https://github.com/nathancahill/Split.js),
[PEP.js](https://github.com/jquery/PEP) and (stripped down)
[lz-string.js](https://github.com/pieroxy/lz-string) libraries that get embedded into
generated bom page.

`units.py` is borrowed from [KiBom](https://github.com/SchrodingersGat/KiBoM)
plugin (MIT license).

`svgpath.py` is heavily based on
[svgpathtools](https://github.com/mathandy/svgpathtools) module (MIT license).

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "InteractiveHtmlBom",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "Eagle,EasyEDA,KiCad,ibom",
    "author": "",
    "author_email": "qu1ck <anlutsenko@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/5c/3a/802ad4f68af580fc033068f8d020a4085134439289daf56cc82b16fa985a/interactivehtmlbom-2.9.0.tar.gz",
    "platform": null,
    "description": "# Interactive HTML BOM plugin for KiCad\n## Supports EasyEDA, Eagle, Fusion360 and Allegro PCB designer\n\n![icon](https://i.imgur.com/js4kDOn.png)\n\nThis plugin generates a convenient Bill of Materials (BOM) listing with the\nability to visually correlate and easily search for components and their placements\non the PCB. It is particularly useful when hand-soldering a prototype, as it allows\nusers to quickly find locations of components groups on the board. It is also possible\nto reverse lookup the component group by clicking on a footprint on the board drawing.\n\nThe plugin utilizes Pcbnew python API to read PCB data and render silkscreen, fab layer,\nfootprint pads, text, and drawings. BOM table fields and grouping is fully configurable,\nadditional columns, such as a manufacturer ID, can be added in Schematic editor and\nimported either through the netlist file, XML file generated by Eeschema's internal\nBOM tool, or from board file itself.\n\nThere is an option to include tracks/zones data as well as netlist information allowing\ndynamic highlight of nets on the board.\n\nFor full description of functionality see [wiki](https://github.com/openscopeproject/InteractiveHtmlBom/wiki).\n\nGenerated html page is fully self contained, doesn't need internet connection to work\nand can be packaged with documentation of your project or hosted anywhere on the web.\n\n[A demo is worth a thousand words.](https://openscopeproject.org/InteractiveHtmlBomDemo/)\n\n## Installation and Usage\n\nSee [project wiki](https://github.com/openscopeproject/InteractiveHtmlBom/wiki/Installation) for instructions.\n\n## License and credits\n\nPlugin code is licensed under MIT license, see `LICENSE` for more info.\n\nHtml page uses [Split.js](https://github.com/nathancahill/Split.js),\n[PEP.js](https://github.com/jquery/PEP) and (stripped down)\n[lz-string.js](https://github.com/pieroxy/lz-string) libraries that get embedded into\ngenerated bom page.\n\n`units.py` is borrowed from [KiBom](https://github.com/SchrodingersGat/KiBoM)\nplugin (MIT license).\n\n`svgpath.py` is heavily based on\n[svgpathtools](https://github.com/mathandy/svgpathtools) module (MIT license).\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Generate Interactive Html BOM for your electronics projects",
    "version": "2.9.0",
    "project_urls": {
        "Documentation": "https://github.com/openscopeproject/InteractiveHtmlBom/wiki",
        "Issues": "https://github.com/openscopeproject/InteractiveHtmlBom/issues",
        "Source": "https://github.com/openscopeproject/InteractiveHtmlBom"
    },
    "split_keywords": [
        "eagle",
        "easyeda",
        "kicad",
        "ibom"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9e821094ebc34cc7db5c0c561019d629742f1828eaaaed78a6a2cd066b744540",
                "md5": "c0c9406fab32dffdbf274fee419a8874",
                "sha256": "4a6eac6bdc9df559a55bc3227ef794eca57b9c15c6685703608934c4a642e7e7"
            },
            "downloads": -1,
            "filename": "interactivehtmlbom-2.9.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c0c9406fab32dffdbf274fee419a8874",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 147635,
            "upload_time": "2024-02-23T19:35:50",
            "upload_time_iso_8601": "2024-02-23T19:35:50.650404Z",
            "url": "https://files.pythonhosted.org/packages/9e/82/1094ebc34cc7db5c0c561019d629742f1828eaaaed78a6a2cd066b744540/interactivehtmlbom-2.9.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5c3a802ad4f68af580fc033068f8d020a4085134439289daf56cc82b16fa985a",
                "md5": "826c886a10493458474e4a152c344b5d",
                "sha256": "339762d275b809ee22967441db2cf569bf34f6afbff6e7d59dd2507e7a50a880"
            },
            "downloads": -1,
            "filename": "interactivehtmlbom-2.9.0.tar.gz",
            "has_sig": false,
            "md5_digest": "826c886a10493458474e4a152c344b5d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 162481,
            "upload_time": "2024-02-23T19:35:53",
            "upload_time_iso_8601": "2024-02-23T19:35:53.960504Z",
            "url": "https://files.pythonhosted.org/packages/5c/3a/802ad4f68af580fc033068f8d020a4085134439289daf56cc82b16fa985a/interactivehtmlbom-2.9.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-23 19:35:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "openscopeproject",
    "github_project": "InteractiveHtmlBom",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "interactivehtmlbom"
}
        
Elapsed time: 0.20426s