Robot Framework KiCAD library
Project description
robotframework-kicadlibrary
A Robot Framework library for validating KiCad designs.
Releases are available via regular PyPI as well as GitHib releases. Example projects/usage is available under the examples/
sub-directory.
Keyword documentation is available online, as well as downloadable via GitHub Releases.
Getting Started
Prerequisites
You'll need an installation of Python, as well as pip
. Please see your operating systems documentation on how to install those tools.
You will also need Robot Framework installed, but if you install using pip
, robot framework will automatically be installed for you.
Installing
Installing using pip:
$ pip install robotframework-kicadlibrary
Using the library
*** Variables ***
Library KiCadLibrary schema=myproject.sch pcb=myproject.kicad_pcb
*** Test cases ***
Module pads should be on grid
Module Pads Should Be On Grid 50 mil reference=.*$
Contributing
Any and all contributions are welcome, in the form of pull requests.
Versioning
We use SemVer for versioning. For the versions available, see the releases on this repository.
Authors
- Martin Kjellstrand - Initial work - madworx
License
This project is licensed under the MIT License - see the LICENSE.txt file for details
Developer information / Preparing a release
To create a release please follow this outline:
- Do your development work in a separate branch.
- Write unit-tests (
tests/
) and/or integration tests (examples/
) for your code. - Once all local tests validate, and you have 100% code coverage, push to GitHub.
If you have commit access to the main repository
- Once build hooks at Github/Sonarcloud/pyup etc have completed, tag a pre-release (
x.y.zrc0
) - If that build completes, perform a PR into
master
, squashing the commit history. - Tag the
master
branch with the new release version, ahdering to semantic versioning. - Remove any
pre
artifacts from Docker Hub and PyPI.
If you don't have commit access to the main repository
- Submit a PR towards the
master
branch of the main repository.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for robotframework-kicadlibrary-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3064bfa90c2138cfd214dc351535699427b30cd17a09bd4118bd5be02e6f5e5d |
|
MD5 | 83d5d437ce249cc3de00456c3810f31e |
|
BLAKE2b-256 | 21742f62cc7f9f3110b0f1a2bc4fb5798cd3901a74b595aa3357e6c8e5b18a7f |
Hashes for robotframework_kicadlibrary-1.1.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e785555b815788bef5d04c62988c399e99726d430d2fdd37ab27173986f81e53 |
|
MD5 | fe4847f1e3c8d81223986dcad9df3b51 |
|
BLAKE2b-256 | 09725bf43b335ecc733817b1db3a15c2b1d130f5fe1fd6a309d499cf13b18efd |