Automatically generate a website showcasing Kicad projects.
Project description
balba
Automatically generate a website showcasing Kicad projects. The website makes it easy to review multiple aspects of a project from any device without the need to download any files or install KiCad.
Project named after Bidens alba.
Getting started
This program assumes the following:
- All your KiCad projects are stored in a single directory, each one in its own subdirectory.
- There exists a
balba.yaml
at the root. - Each project has a
README.md
at its root. - Said
README.md
has the appropriate front matter.
The structure should look something like:
├── balba.yaml
├── cocoro
│ ├── cocoro.kicad_pcb
│ ├── cocoro.kicad_prl
│ ├── cocoro.kicad_pro
│ ├── cocoro.kicad_sch
│ ├── ledc.kicad_sch
│ └── README.md
├── other_project
| ├── ...
Once that's done, all you have to do is cd
into the root directory and run balba
. By default, the output will
be stored on ./balba-build
.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
balba-0.2.0.tar.gz
(11.3 kB
view hashes)
Built Distribution
balba-0.2.0-py3-none-any.whl
(9.9 kB
view hashes)