Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/workloads/baedge
B{ae}dge Computing Server
https://github.com/workloads/baedge
eink nomad raspberry-pi seeedstudio waveshare
Last synced: about 1 month ago
JSON representation
B{ae}dge Computing Server
- Host: GitHub
- URL: https://github.com/workloads/baedge
- Owner: workloads
- Created: 2024-01-28T14:04:58.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-13T18:11:07.000Z (5 months ago)
- Last Synced: 2024-08-13T21:26:37.920Z (5 months ago)
- Topics: eink, nomad, raspberry-pi, seeedstudio, waveshare
- Language: Python
- Homepage: https://github.com/workloads/baedge
- Size: 5.69 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# {Ba,E}dge Computing Server
> Python-based server for {Ba,E}dge Computing.
## Table of Contents
* [{Ba,E}dge Computing Server](#baedge-computing-server)
* [Table of Contents](#table-of-contents)
* [Requirements](#requirements)
* [Hardware](#hardware)
* [Software](#software)
* [Development](#development)
* [Usage](#usage)
* [Notes](#notes)
* [Contributors](#contributors)
* [License](#license)
## Requirements
### Hardware
- [Raspberry Pi Zero 2W](https://www.raspberrypi.org/products/raspberry-pi-zero-2-w/)
- Waveshare eInk display
- [2.13 inch display](https://www.waveshare.com/wiki/2.13inch_e-Paper_HAT_(B))
- (preferred) [2.7 inch display](https://www.waveshare.com/wiki/2.7inch_e-Paper_HAT_(B))
- [2.9 inch display](https://www.waveshare.com/wiki/2.9inch_e-Paper_Module_(B))
### Software
See [requirements.txt](./requirements.txt) for a list of Python dependencies.
#### Development
For development and testing of this repository:
- `flake8` `7.0.0` or [newer](https://pypi.org/project/flake8/)
- `pylint` `3.0.0` or [newer](https://pypi.org/project/pylint/)
These dependencies can be installed using the following command:
```shell
make deps-dev
```
## Usage
This repository provides a [Makefile](./Makefile)-based workflow.
Running `make` without commands will print out the following help information:
```text
🎫 {BA,E}DGE SERVER
Target Description Usage
routes list Baedge Server routes using Flask `make routes`
run run Baedge Server using Flask `make run`
print-env print environment information `make print-env`
print-gpio print GPIO information using Python `make print-gpio`
screen set Baedge Screen `make screen screen=`
snyk check Python files using Snyk `make snyk`
deps install Python dependencies using pip `make deps`
deps-dev install Python development dependencies using pip `make deps-dev`
fix fix Python files using autopep8 `make fix`
lint lint Python files using Flake8 and Pylint `make lint`
help display a list of Make Targets `make help`
_listincludes list all included Makefiles and *.mk files `make _listincludes`
_selfcheck lint Makefile `make _selfcheck`
```
## Notes
The `baedge` application is designed to be orchestrated using the [`baedge` Nomad Pack](https://github.com/workloads/nomad-pack-registry/tree/main/packs/baedge) available in the [@workloads Nomad Pack Registry](https://github.com/workloads/nomad-pack-registry).
## Contributors
For a list of current (and past) contributors to this repository, see [GitHub](https://github.com/workloads/baedge-server/graphs/contributors).
## License
Licensed under the Apache License, Version 2.0 (the "License").
You may download a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
See the License for the specific language governing permissions and limitations under the License.