Skip to main content

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

Project description

rit-housing-data-schema

PyPI Changelog License

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

Installation

Install this library using pip:

pip install rit-housing-data-schema

Usage

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

from rit_housing_data_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 rit-housing-data-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 rit_housing_data_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

rit-housing-data-schema-0.1.0.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

rit_housing_data_schema-0.1.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file rit-housing-data-schema-0.1.0.tar.gz.

File metadata

File hashes

Hashes for rit-housing-data-schema-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6f40d03e3178472e50f5af657a239b5f65130fa314602a780210ae2558c4b2c7
MD5 072dda2f0b3e4f9ca3769a836d2434e4
BLAKE2b-256 fa7db191227886bc174db1fb3496aeb7abeaf22deed6b8be65cebfb18b27c7e1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rit_housing_data_schema-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f8f957850f283dcdfe132e0073f206e8f965702f8fe433bf28f239b6a9629abf
MD5 5ad156e432d620e725f504519ea87165
BLAKE2b-256 1df4dfe5659b87b782bcc414d60705cf42a49fa2aff232a89b842009b31e0c29

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