Skip to content

Commit 7537451

Browse files
authored
Merge pull request #1003 from cmu-delphi/utils-docs-2
Delphi Utils readme and setup.py update
2 parents b277922 + e59a4ce commit 7537451

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

_delphi_utils_python/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,18 @@ This package provides various utilities used by the [Delphi group](https://delph
44
University](https://www.cmu.edu) for its data pipelines and analyses.
55

66
Submodules:
7-
- `validator`: Data sanity checks and anomaly detection.
87
- `archive`: Diffing and archiving CSV files.
98
- `export`: DataFrame to CSV export.
109
- `geomap`: Mappings between geographic resolutions.
1110
- `logger`: Structured JSON logger.
11+
- `nancodes`: Enum constants encoding not-a-number cases.
1212
- `runner`: Orchestrator for running an indicator pipeline.
1313
- `signal`: Indicator (signal) naming.
1414
- `slack_notifier`: Slack notification integration.
1515
- `smooth`: Data smoothing functions.
1616
- `utils`: JSON parameter interactions.
17+
- `validator`: Data sanity checks and anomaly detection.
18+
1719

1820
Source code can be found here:
1921
[https://github.com/cmu-delphi/covidcast-indicators/](https://github.com/cmu-delphi/covidcast-indicators/)

_delphi_utils_python/setup.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
from setuptools import setup
22
from setuptools import find_packages
33

4+
with open("README.md", "r") as f:
5+
long_description = f.read()
6+
47
required = [
58
"boto3",
69
"covidcast",
@@ -23,6 +26,8 @@
2326
name="delphi_utils",
2427
version="0.1.0",
2528
description="Shared Utility Functions for Indicators",
29+
long_description=long_description,
30+
long_description_content_type="text/markdown",
2631
author="",
2732
author_email="",
2833
url="https://github.com/cmu-delphi/",

0 commit comments

Comments
 (0)