readme.md

architect-functions

Runtime utility package for Functional Web Apps (FWAs) built with Architect

Check out the full docs for this library and Architect

Install

Within your Architect project directory, add architect-functions to its root requirements.txt:

pip install architect-functions -r requirements.txt

You may also add architect-functions to individual Lambda requirements.txt files, but we suggest making use of Architect's automated Lambda treeshaking. See the Architect dependency management guide for more details.

Usage

import arc          # Import all tools, or
import arc.events   # @events pub/sub
import arc.http     # @http tools + sessions
import arc.queues   # @queues pub/sub
import arc.services # Architect resource / service discovery
import arc.tables   # @tables DynamoDB helper methods + API client
import arc.ws       # @ws WebSocket helper + API client

API

@events methods

• arc.events.parse()
• arc.events.publish()

@http methods

• arc.http.parse_body()
• arc.http.res()
• arc.http.session_read()
• arc.http.session_write()

@queues methods

• arc.queues.parse()
• arc.queues.publish()

Service discovery

• arc.services()

@tables methods

• arc.tables.name()
• arc.tables.table()

@ws methods

• arc.ws.api()
• arc.ws.close()
• arc.ws.info()
• arc.ws.send()

---

Development

Install Pipenv

pipenv install --dev

---

Testing

pipenv run pytest