| Name | vcbblueprint JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | A library for decoding Virtual Circuit Board blueprint strings |
| upload_time | 2023-06-01 19:44:46 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2023 Brandon Martin-Anderson Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
blueprint
vcb
virtual circuit board
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
numpy
zstd
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Visual Circuit Board (VCB) Python Library
## Description
This Python library provides a way to read Visual Circuit Board (VCB) blueprint strings and convert them into a convenient data structure.
## Installation
pip install vcbblueprint
## Usage
Here is a simple usage example:
```python
import vcbblueprint
blueprint_string = "VCB+..." # a VCB blueprint string
# read the blueprint string and get the version and layers
version, layers = vcbblueprint.read_blueprint(blueprint_string)
# use the filter function to get a boolean matrix of pixels of a
# specific component type
and_pixels = vcbblueprint.filter(layers[0], vcbblueprint.ComponentType.AND)
```
## Contributions
Contributions are welcome. Feel free to open an issue or submit a pull request.
Raw data
{
"_id": null,
"home_page": "",
"name": "vcbblueprint",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "blueprint,vcb,virtual circuit board",
"author": "",
"author_email": "Brandon Martin-Anderson <badhill@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/6d/47/ec8fd5bcf2be93be538985b2dc48b659c525ef4f13d4b6561c3e3c721836/vcbblueprint-0.1.1.tar.gz",
"platform": null,
"description": "# Visual Circuit Board (VCB) Python Library\n\n## Description\n\nThis Python library provides a way to read Visual Circuit Board (VCB) blueprint strings and convert them into a convenient data structure.\n\n## Installation\n\n pip install vcbblueprint\n\n## Usage\n\nHere is a simple usage example:\n\n```python\nimport vcbblueprint\n\nblueprint_string = \"VCB+...\" # a VCB blueprint string\n\n# read the blueprint string and get the version and layers\nversion, layers = vcbblueprint.read_blueprint(blueprint_string)\n\n# use the filter function to get a boolean matrix of pixels of a\n# specific component type\nand_pixels = vcbblueprint.filter(layers[0], vcbblueprint.ComponentType.AND)\n```\n\n## Contributions\n\nContributions are welcome. Feel free to open an issue or submit a pull request.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Brandon Martin-Anderson Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A library for decoding Virtual Circuit Board blueprint strings",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/bmander/vcbblueprint/",
"Repository": "https://github.com/bmander/vcbblueprint.git"
},
"split_keywords": [
"blueprint",
"vcb",
"virtual circuit board"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3126e114903a0f91d93493880cb86a3e815a3a5eaacfcec6c46d67c3310476e7",
"md5": "dc3ebc98bd029215d7f334a3b3f98a03",
"sha256": "b087da393fd3207948a2eff1ad4ad6d41059436b62e5b421bd538aef95868385"
},
"downloads": -1,
"filename": "vcbblueprint-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc3ebc98bd029215d7f334a3b3f98a03",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4879,
"upload_time": "2023-06-01T19:44:44",
"upload_time_iso_8601": "2023-06-01T19:44:44.202170Z",
"url": "https://files.pythonhosted.org/packages/31/26/e114903a0f91d93493880cb86a3e815a3a5eaacfcec6c46d67c3310476e7/vcbblueprint-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d47ec8fd5bcf2be93be538985b2dc48b659c525ef4f13d4b6561c3e3c721836",
"md5": "4fd78dd8b8191a7c930958fe61235a50",
"sha256": "5af9598ab34f0a6d1038336ccf877df4ff161aea7db4a403aef417edc73c5ee8"
},
"downloads": -1,
"filename": "vcbblueprint-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "4fd78dd8b8191a7c930958fe61235a50",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 7379,
"upload_time": "2023-06-01T19:44:46",
"upload_time_iso_8601": "2023-06-01T19:44:46.676944Z",
"url": "https://files.pythonhosted.org/packages/6d/47/ec8fd5bcf2be93be538985b2dc48b659c525ef4f13d4b6561c3e3c721836/vcbblueprint-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-01 19:44:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bmander",
"github_project": "vcbblueprint",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
"~=",
"1.24.0"
]
]
},
{
"name": "zstd",
"specs": [
[
"~=",
"1.5.0"
]
]
}
],
"lcname": "vcbblueprint"
}
