fzp2js
v1.0.1
Published
A lightweight yet robust converter between FZP and JSON
Downloads
10
Readme
fzp2js
Lightweight yet robust converter between FZP files and the JSON representation of Fritzing parts. Based on the FZP file format outlined in the Fritzing documentation and the JSON model outlined in fzp-js.
install...
with npm
npm install fzp2js
with yarn
yarn add fzp2js
why fzp2js?
Both the Fritzing documentation and fzp-js have components of FZP files missing that were found in parts located in the resources/parts/core directory. To ensure that this library didn't miss those components, it was tested against all default Fritzing parts found in resources/parts/core until it could successfully produce identical versions. In addition, both the documentation and source code for fzp-js were used as a guide to ensure compatibility with existing software and specifications.
usage
const { FritzingPart } = require('fzp2js');
//FZP contents as a string
const fzp = ...
FritzingPart.fromFZP(fzp).then( (part) => {
//do something with the FritzingPart here
});
documentation
The library is completely documented, following the JSDoc format. The documentation is hosted at karpawich.github.io/fzp2js.
the future
- Travis integration for testing with sample FZP files
My next project is to make a converter for FZ (Fritzing sketch) files. If you'd like to collaborate, feel free to contact me at [email protected].
license
This library is licensed under the GNU GPLv3 license, similar to Fritzing itself.