{ "info": { "author": "Thomas Pointhuber", "author_email": "thomas.pointhuber@gmx.at", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Programming Language :: Python", "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)" ], "description": "This repository contains scripts to generate custom KiCAD footprints using python, and a framework which allows us to\ncreate custom KiCAD footprint. A big bunch of footprints of the KiCad library was developed using this framework.\n\n# KicadModTree\n\n**Licence:** GNU GPLv3+\n\n**Maintainer:** Thomas Pointhuber\n\n[![Build Status](https://travis-ci.org/pointhi/kicad-footprint-generator.svg?branch=master)](https://travis-ci.org/pointhi/kicad-footprint-generator)\n[![Code Climate](https://codeclimate.com/github/pointhi/kicad-footprint-generator/badges/gpa.svg)](https://codeclimate.com/github/pointhi/kicad-footprint-generator)\n[![Documentation Status](https://readthedocs.org/projects/kicad-footprint-generator/badge/?version=latest)](http://kicad-footprint-generator.readthedocs.io/en/latest/?badge=latest)\n\n**Supports:** Python 2.7 and 3.3+\n\n## About\n\nI started drawing a bunch of similar footprints for KiCAD, like connectors which are mainly one base shape, and different\namount of pins. To be able to update/improve those footprints quickly I decided to write my own footprint generator Framework,\nto allow simple creation of easy as well complex shapes.\n\nThis is my second approach (the first one can be found in the git history). This solution should be able to be easy to\nuse, to read and also be easy to expand with custom nodes.\n\n\n## Overview\n\nThis framework is mainly based on the idea of scripted CAD systems (for example OpenSCAD). This means, everything is a\nnode, and can be structured like a tree. In other words, you can group parts of the footprint, and translate them in any\nway you want. Also cloning & co. is no problem anymore because of this concept.\n\nTo be able to create custom Nodes, I separated the system in two parts. Base nodes, which represents simple structures\nand also be used by KiCAD itself, and specialized nodes which alter the behaviour of base nodes (for example positioning),\nor represent a specialized usage of base nodes (for example RectLine).\n\nWhen you serialize your footprint, the serialize command only has to handle base nodes, because all other nodes are based\nupon the base nodes. This allows us to write specialized nodes without worrying about the FileHandlers or other core systems.\nYou simply create your special node, and the framework knows how to handle it seamlessly.\n\nPlease look into the **[Documentation](http://kicad-footprint-generator.readthedocs.io/en/latest/)** for further details\n\n```\nKicadModTree - The KicadModTree framework which is used for footprint generation\ndocs - Files required to generate a sphinx documentation\nscripts - scripts which are generating footprints based on this library\n```\n\n## Development\n\n### Install development Dependencies\n\n```sh\nmanage.sh update_dev_packages\n```\n\n### run tests\n\n```sh\nmanage.sh tests\n```\n\n## Example Script\n\n```python\nfrom KicadModTree import *\n\nfootprint_name = \"example_footprint\"\n\n# init kicad footprint\nkicad_mod = Footprint(footprint_name)\nkicad_mod.setDescription(\"A example footprint\")\nkicad_mod.setTags(\"example\")\n\n# set general values\nkicad_mod.append(Text(type='reference', text='REF**', at=[0, -3], layer='F.SilkS'))\nkicad_mod.append(Text(type='value', text=footprint_name, at=[1.5, 3], layer='F.Fab'))\n\n# create silscreen\nkicad_mod.append(RectLine(start=[-2, -2], end=[5, 2], layer='F.SilkS'))\n\n# create courtyard\nkicad_mod.append(RectLine(start=[-2.25, -2.25], end=[5.25, 2.25], layer='F.CrtYd'))\n\n# create pads\nkicad_mod.append(Pad(number=1, type=Pad.TYPE_THT, shape=Pad.SHAPE_RECT,\n at=[0, 0], size=[2, 2], drill=1.2, layers=Pad.LAYERS_THT))\nkicad_mod.append(Pad(number=2, type=Pad.TYPE_THT, shape=Pad.SHAPE_CIRCLE,\n at=[3, 0], size=[2, 2], drill=1.2, layers=Pad.LAYERS_THT))\n\n# add model\nkicad_mod.append(Model(filename=\"example.3dshapes/example_footprint.wrl\",\n at=[0, 0, 0], scale=[1, 1, 1], rotate=[0, 0, 0]))\n\n# output kicad model\nfile_handler = KicadFileHandler(kicad_mod)\nfile_handler.writeFile('example_footprint.kicad_mod')\n```\n\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/pointhi/kicad-footprint-generator", "keywords": "", "license": "GPL3+", "maintainer": "", "maintainer_email": "", "name": "KicadModTree", "package_url": "https://pypi.org/project/KicadModTree/", "platform": "", "project_url": "https://pypi.org/project/KicadModTree/", "project_urls": { "Homepage": "https://github.com/pointhi/kicad-footprint-generator" }, "release_url": "https://pypi.org/project/KicadModTree/1.0.3/", "requires_dist": null, "requires_python": "", "summary": "creating kicad footprints using python scripts", "version": "1.0.3" }, "last_serial": 4129557, "releases": { "1.0.3": [ { "comment_text": "", "digests": { "md5": "f39053c1490ded524a189413a649f324", "sha256": "cb6ac2eee8216bf21c250eb9147ee6b9248725a2f57d51b43a6695ca8d153bd1" }, "downloads": -1, "filename": "KicadModTree-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "f39053c1490ded524a189413a649f324", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 59944, "upload_time": "2018-08-02T17:38:23", "url": "https://files.pythonhosted.org/packages/21/3d/7a2c7d28d3af0f7c1020313a71646afa0ecaf51077143e9fbec7c804ecda/KicadModTree-1.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b4bec9366d65ec81c68669d064cb1e5b", "sha256": "fe83ed3aacfa029f6b1500635de6a85bd05d23e1a2077dc42f6cbec59274e72b" }, "downloads": -1, "filename": "KicadModTree-1.0.3.tar.gz", "has_sig": false, "md5_digest": "b4bec9366d65ec81c68669d064cb1e5b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 35427, "upload_time": "2018-08-02T17:38:25", "url": "https://files.pythonhosted.org/packages/32/bf/03d74cafe091fa62cb7f96134b4ea9b32c3a328727e492fc362e263f2875/KicadModTree-1.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f39053c1490ded524a189413a649f324", "sha256": "cb6ac2eee8216bf21c250eb9147ee6b9248725a2f57d51b43a6695ca8d153bd1" }, "downloads": -1, "filename": "KicadModTree-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "f39053c1490ded524a189413a649f324", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 59944, "upload_time": "2018-08-02T17:38:23", "url": "https://files.pythonhosted.org/packages/21/3d/7a2c7d28d3af0f7c1020313a71646afa0ecaf51077143e9fbec7c804ecda/KicadModTree-1.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b4bec9366d65ec81c68669d064cb1e5b", "sha256": "fe83ed3aacfa029f6b1500635de6a85bd05d23e1a2077dc42f6cbec59274e72b" }, "downloads": -1, "filename": "KicadModTree-1.0.3.tar.gz", "has_sig": false, "md5_digest": "b4bec9366d65ec81c68669d064cb1e5b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 35427, "upload_time": "2018-08-02T17:38:25", "url": "https://files.pythonhosted.org/packages/32/bf/03d74cafe091fa62cb7f96134b4ea9b32c3a328727e492fc362e263f2875/KicadModTree-1.0.3.tar.gz" } ] }