Skip to main content

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

Project description

campuspulse-event-ingest-schema

PyPI Changelog License

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/*

Project details


Download files

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

Source Distribution

campuspulse-event-ingest-schema-0.1.0.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file campuspulse-event-ingest-schema-0.1.0.tar.gz.

File metadata

  • Download URL: campuspulse-event-ingest-schema-0.1.0.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.6 importlib-metadata/6.6.0 keyring/23.13.1 pkginfo/1.9.6 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.64.1 urllib3/1.26.5 CPython/3.10.12

File hashes

Hashes for campuspulse-event-ingest-schema-0.1.0.tar.gz
Algorithm Hash digest
SHA256 848d7b7e9cf472d087a7df1524ee718b6ee5adf76e798eeebec0edb4f2f8237e
MD5 37587cacc23c32faf3e682be829b2427
BLAKE2b-256 4dd8585636583ca7685a955421c81c7c455704d1b4ea5f27f16eac12ebe6b1d5

See more details on using hashes here.

File details

Details for the file campuspulse_event_ingest_schema-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: campuspulse_event_ingest_schema-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.6 importlib-metadata/6.6.0 keyring/23.13.1 pkginfo/1.9.6 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.64.1 urllib3/1.26.5 CPython/3.10.12

File hashes

Hashes for campuspulse_event_ingest_schema-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bac265abe1db151b5770d4f43697b87aed682f9305d6062e4a73af07b5438c9f
MD5 f6bcc498412a0af1220ba4c581c5194a
BLAKE2b-256 20707ea1e9004e002011f800c1ef6e2fbffef4c3252516abae8a94bd7380e68f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page