Merge pull request #1003 from cmu-delphi/utils-docs-2

Delphi Utils readme and setup.py update

Author: chinandrew

_delphi_utils_python/README.md

@@ -4,16 +4,18 @@ This package provides various utilities used by the [Delphi group](https://delph
 University](https://www.cmu.edu) for its data pipelines and analyses.
 
 Submodules:
-- `validator`: Data sanity checks and anomaly detection.
 - `archive`: Diffing and archiving CSV files.
 - `export`: DataFrame to CSV export.
 - `geomap`: Mappings between geographic resolutions.
 - `logger`: Structured JSON logger.
+- `nancodes`: Enum constants encoding not-a-number cases.
 - `runner`: Orchestrator for running an indicator pipeline.
 - `signal`: Indicator (signal) naming.
 - `slack_notifier`:  Slack notification integration.
 - `smooth`: Data smoothing functions.
 - `utils`: JSON parameter interactions.
+- `validator`: Data sanity checks and anomaly detection.
+
 
 Source code can be found here: 
 [https://github.com/cmu-delphi/covidcast-indicators/](https://github.com/cmu-delphi/covidcast-indicators/)

_delphi_utils_python/setup.py

@@ -1,6 +1,9 @@
 from setuptools import setup
 from setuptools import find_packages
 
+with open("README.md", "r") as f:
+  long_description = f.read()
+
 required = [
     "boto3",
     "covidcast",
@@ -23,6 +26,8 @@
     name="delphi_utils",
     version="0.1.0",
     description="Shared Utility Functions for Indicators",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     author="",
     author_email="",
     url="https://github.com/cmu-delphi/",