Core components of actfw, independent of specific devices
Project description
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
Usage
Construct your application with a task parallel model
- Application
actfw_core.Application
: Main application
- Workers
actfw_core.task.Producer
: Task generatoractfw_core.capture.V4LCameraCapture
: Generate UVC camera capture image
actfw_core.task.Pipe
: Task to Task converteractfw_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)
- Register to
Application
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 tomaster
branch. - Create GitHub release from
master
branch's HEAD.- Draft a new release.
- Create new tag named
release-<New version>
(e.g.release-1.4.0
) fromChoose a tag
pull down menu. - Write title and description.
- Publish release.
- Then CI will build/upload package to PyPI & API doc to GitHub Pages.
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
actfw_core-2.4.0.tar.gz
(51.0 kB
view hashes)
Built Distribution
actfw_core-2.4.0-py3-none-any.whl
(59.6 kB
view hashes)
Close
Hashes for actfw_core-2.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f78b6e6df01fc19bbe338b83ecc0a299b065e5b40912af3ee310d679e1067272 |
|
MD5 | cf8870452b4ccd64beed2bd9e45ac57e |
|
BLAKE2b-256 | 2c6311adf74717fa6471edb3474b6d965c52cee65c7e4d2729bcaf5489ca2633 |