Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/whitelynx/spkb
A SolidPython-based library for building custom keyboards
https://github.com/whitelynx/spkb
Last synced: about 1 month ago
JSON representation
A SolidPython-based library for building custom keyboards
- Host: GitHub
- URL: https://github.com/whitelynx/spkb
- Owner: whitelynx
- License: bsd-3-clause
- Created: 2023-09-04T00:31:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-12T23:59:26.000Z (about 2 months ago)
- Last Synced: 2024-11-13T00:19:30.508Z (about 2 months ago)
- Language: OpenSCAD
- Size: 467 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SPKB
_SolidPython-based Keyboard Builder_
A [SolidPython][]-based library for building custom keyboards with [Python][] and [OpenSCAD][].
Some portions ported from Clojure, originally from [the Dactyl Keyboard][] and my fork thereof,
[the Dactyl Lynx Keyboard][].
[SolidPython]: https://github.com/jeff-dh/SolidPython
[Python]: https://www.python.org/
[OpenSCAD]: https://openscad.org/
[the Dactyl Keyboard]: https://github.com/adereth/dactyl-keyboard
[the Dactyl Lynx Keyboard]: https://github.com/whitelynx/dactyl-lynx-keyboard
## Prerequisites
* [Python][] version 3.11 or newer
* [pipenv](https://pipenv.pypa.io/en/latest/)
## Installing dependencies
```bash
pipenv install
```
## Usage
For simply generating interesting key testers, see the example scripts in the `examples/`
directory.
---
In your own code, you can simply import from the `spkb` module:
```python
import * from spkb
```
See `spkb/__init__.py` for more detail about what's exported.
You can also import directly from the submodules, which is especially useful for objects that
aren't re-exported by the top-level module:
```python
from spkb.switch_plate import plate_thickness, mx_plate
from spkb.board_mount import stm32_blackpill
from spkb.keycaps import sa_double_length, sa_cap
```
## Testing
You can run simple tests from some of the submodules:
```bash
pipenv run python -m spkb.switch_plate # Renders a variety of keyswitch plates (sockets)
pipenv run python -m spkb.keycaps # Renders the built-in keycap approximations
pipenv run python -m spkb.single_tester # Renders a single-key tester
```
## Links
* [parametric-key-tester](https://github.com/whitelynx/parametric-key-tester) - the original project this library was forked from
* [the Dactyl Keyboard][] and my fork, [the Dactyl Lynx Keyboard][] - original switch sockets, keycap approximations, etc.
## License
This project is released under [the BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause).