actfw-core

Core components of actfw, a framework for Actcast Application written in Python. actfw-core is intended to be independent of any specific device.

Installation

sudo apt-get update
sudo apt-get install -y python3-pip python3-pil 
sudo apt-get install -y libv4l-0 libv4lconvert0  # if using `V4LCameraCapture`
pip3 install actfw-core

Document

API References

Usage

Construct your application with a task parallel model

Application
- actfw_core.Application : Main application
Workers
- actfw_core.task.Producer : Task generator
  - actfw_core.capture.V4LCameraCapture : Generate UVC camera capture image
- actfw_core.task.Pipe : Task to Task converter
- actfw_core.task.Consumer : Task terminator

Each worker is executed in parallel.

User should

Define subclass of Producer/Pipe/Consumer

class MyPipe(actfw_core.task.Pipe):
    def proc(self, i):
        ...

Connect defined worker objects

p  = MyProducer()
f1 = MyPipe()
f2 = MyPipe()
c  = MyConsumer()
p.connect(f1)
f1.connect(f2)
f2.connect(c)

app = actfw_core.Application()
app.register_task(p)
app.register_task(f1)
app.register_task(f2)
app.register_task(c)

Execute application

app.run()

Development Guide

Installation of dev requirements

pip3 install poetry
poetry install

Running tests

poetry run pytest -v

Releasing package & API doc

CI will automatically do. Follow the following branch/tag rules.

Make changes for next version in master branch (via pull-requests).
Make a PR that updates version in pyproject.toml and merge it to master branch.
Create GitHub release from master branch's HEAD.
1. Draft a new release.
2. Create new tag named release-<New version> (e.g. release-1.4.0) from Choose a tag pull down menu.
3. Write title and description.
4. Publish release.
Then CI will build/upload package to PyPI & API doc to GitHub Pages.