Skip to main content

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 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)
  • 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 nose2 -v

Releasing package & API doc

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for actfw-core, version 2.1.1
Filename, size File type Python version Upload date Hashes
Filename, size actfw_core-2.1.1-py3-none-any.whl (32.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size actfw-core-2.1.1.tar.gz (27.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page