Package: electronic-package-descriptor-by-sporniket
Sporniket's electronic package descriptor[WARNING] Please read carefully this note before using this project. It contains important facts.ContentWhat isSporniket's electronic package descriptor, and when to use it ?What should you know before usingSporniket's electronic package descriptor?How to useSporniket's electronic package descriptor?Known issuesMiscellanous1. What isSporniket's electronic package descriptor, and when to use it ?Sporniket's electronic package descriptoris a python library that provide an abstract model and API for helping generate component symbols for EDA suites like Kicad.LicenceSporniket's electronic package descriptoris free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.Sporniket's electronic package descriptoris distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.Release notesv0.0.7Resolves #30 : [bug] a group having some pins recognized as bus hangsv0.0.6Resolves #29 : Deserializer should support missing optionnal fields in meta dataNarrow down supported python versions matrix : 3.8, 3.9, 3.10v0.0.5Resolves #26 : Supplemental pins layouts : DIM, SIMResolves #27 : Groups with bus pattern MUST have only 'bus' in slotsv0.0.4Resolves #24 : [bug][parser] The name of the package should be uppercase and replace some non-alphanumeric characters by '_'v0.0.3The model of an electronic package is completeA parser of datasheet written in Markdown formatA JSON format for serializing and deserializing.v0.0.2The model of a group of pins is completev0.0.1the model of a pin is complete2. What should you know before usingSporniket's electronic package descriptor?Sporniket's electronic package descriptoris written using python version 3.6, and should work with python version 3.7 up to 3.10.It relies on the following packages to build and test :buildpytestIt also relies on the following package to enforce source formatting :blackseeREADME packagingfor further details.Sporniket's electronic package descriptormaintains a set of specifications :A JSON based format : seeREADME jsonA Markdown based datasheet structure : seeREADME datasheetDo not useSporniket's electronic package descriptorif this project is not suitable for your project.3. How to useSporniket's electronic package descriptor?From sourcesTo get the latest available models, one must clone the git repository, build and install the package.git clone https://github.com/sporniket/electronic-package-descriptor.git
cd electronic-package-descriptor
python3 -m build && python3 -m pip install --force-reinstall dist/*.whlThen, import the library in your code :fromelectronic_package_descriptorimport*Using pippip install electronic-package-descriptor-by-sporniketThen, import the library in your code :fromelectronic_package_descriptorimport*4. Known issuesSee theproject issuespage.5. MiscellanousSupplemental documentation :README packaging: some technical details about packaging this project.README json: the specification of the JSON-based format.README datasheet: the specification of the Markdown-based datasheet structure.Report issuesUse theproject issuespage.