Metadata-Version: 2.1
Name: vaccine-feed-ingest-schema
Version: 1.2.5
Summary: Normalized data schema for the output of the vaccine-feed-ingest pipeline.
Home-page: https://github.com/CAVaccineInventory/vaccine-feed-ingest-schema
Author: Vaccinate The States
License: MIT
Project-URL: Issues, https://github.com/CAVaccineInventory/vaccine-feed-ingest-schema/issues
Project-URL: CI, https://github.com/CAVaccineInventory/vaccine-feed-ingest-schema/actions
Project-URL: Changelog, https://github.com/CAVaccineInventory/vaccine-feed-ingest-schema/releases
Description: # vaccine-feed-ingest-schema
        
        [![PyPI](https://img.shields.io/pypi/v/vaccine-feed-ingest-schema.svg)](https://pypi.org/project/vaccine-feed-ingest-schema/)
        [![Changelog](https://img.shields.io/github/v/release/CAVaccineInventory/vaccine-feed-ingest-schema?include_prereleases&label=changelog)](https://github.com/CAVaccineInventory/vaccine-feed-ingest-schema/releases)
        [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/CAVaccineInventory/vaccine-feed-ingest-schema/blob/main/LICENSE)
        
        Normalized data schema for the output of the vaccine-feed-ingest pipeline.
        
        ## Installation
        
        Install this library using `pip`:
        
        ```sh
        pip install vaccine-feed-ingest-schema
        ```
        
        ## Usage
        
        Import this package then use it to construct normalized objects with type
        enforcement.
        
        ```python
        from vaccine_feed_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
        [`vaccine-feed-ingest` wiki](https://github.com/CAVaccineInventory/vaccine-feed-ingest/wiki/Normalized-Location-Schema).
        
        ## Development
        
        To contribute to this library, first checkout the code. Then create a new
        virtual environment:
        
        ```sh
        cd vaccine-feed-ingest-schema
        python -mvenv venv
        source venv/bin/activate
        ```
        
        Or if you are using `pipenv`:
        
        ```sh
        pipenv shell
        ```
        
        Now install the dependencies, linters, and tests:
        
        ```sh
        pip install -e '.[lint,test]'
        ```
        
        To run code formatters:
        
        ```sh
        isort .
        black .
        ```
        
        To run linters:
        
        ```sh
        mypy .
        flake8 vaccine_feed_ingest_schema
        ```
        
        To run the tests:
        
        ```sh
        pytest
        ```
        
Platform: UNKNOWN
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: lint
