memberPlumbing/README.md

Claremont MakerSpace Member Plumbing

This repo contains a set of scripts to sync data around for the Claremont MakerSpace. They primarily revolve around pulling member data from MembershipWorks and pushing it out to various systems at the Space.

Setup

This project uses Poetry for dependency management. Typical usage is first running poetry install to create a virtualenv and install dependencies, then running poetry run <script> to start a specific script.

Config

Many of the scripts use data from a config.yaml in the current working directory when they are run. There is an example config in config.example.yaml which has been stripped of authentication information.

Scripts

The primary entry points have scripts entries (tool.poetry.scripts) in pyproject.toml. They assume that they are being run from a module, so must be run with poetry run <script> or python -m memberPlumbing.<script>.

doorUpdater

Retrieves member information from MembershipWorks and pushes it out to the HID Edge Evo SOLO controllers that do access control at the Space. Configuration lives in config.yaml.

ucsAccounts

Retrieves member information from MembershipWorks and pushes it out to UCS, which we use as a domain controller for the Windows computers at the Space.

sqlExport

Retrieves account and transaction information from MembershipWorks, and pushes it to a MariaDB database for use in other projects. Schemas are defined with peewee in memberPlumbing/mw_models.py.

upcomingEvents

Retrieves upcoming events from MembershipWorks and formats them for a WordPress post.

hidEvents

Retrieves events from the HID Evo Solo door controllers, and pushes them to a SQL database.

Systemd

There are systemd units in the systemd folder, which can be used to run the various scripts regularly.