campuspulse-event-ingest-schema

Normalized data schema for the output of the data-ingest pipeline.

Installation

Install this library using pip:

pip install campuspulse-event-ingest-schema

Usage

Import this package then use it to construct normalized objects with type enforcement.

from campuspulse_event_ingest_schema import location


location.NormalizedLocation(
  id="vaccinebot:uuid-for-site",
  source=location.Source(
    source="vaccinebot",
    id="uuid-for-site",
    fetched_from_uri="https://vaccinateTheStates.com",
    published_at="2021-01-13T00:00:00-08:00",
    data={},
  )
)

For more details on the schema, read the inline comments or the data-ingest wiki.

Development

To contribute to this library, first checkout the code. Then create a new virtual environment:

cd campuspulse-event-ingest-schema
python -mvenv venv
source venv/bin/activate

Or if you are using pipenv:

pipenv shell

Now install the dependencies, linters, and tests:

pip install -e '.[lint,test]'

To run code formatters:

isort .
black .

To run linters:

mypy .
flake8 campuspulse_event_ingest_schema

To run the tests:

pytest

Release

ideally from within a virtual env as described above...

pip install build twine
python -m build
twine check dist/*
twine upload dist/*