add readme for pypi

README-PYPI.md

@@ -0,0 +1,20 @@
+# DP Wizard
+
+DP Wizard guides the user through the application of differential privacy.
+After selecting a local CSV, users are prompted to describe to the anlysis they need.
+Output options include:
+- A Jupyter notebook which demonstrates how to use [OpenDP](https://docs.opendp.org/).
+- A plain Python script.
+- Text and CSV reports.
+
+## Usage
+
+```
+usage: dp-wizard [-h] [--csv CSV_PATH] [--contrib CONTRIB] [--demo]
+
+options:
+  -h, --help         show this help message and exit
+  --csv CSV_PATH     Path to CSV containing private data
+  --contrib CONTRIB  How many rows can an individual contribute?
+  --demo             Use generated fake CSV for a quick demo
+```

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 name = "dp_wizard"
 authors = [{name = "Chuck McCallum", email = "[email protected]"}]
-readme = "README.md"
+readme = "README-PYPI.md"
 license = {file = "LICENSE"}
 classifiers = ["License :: OSI Approved :: MIT License"]
 dynamic = ["version", "description"]

tests/utils/test_argparse_helpers.py

@@ -22,9 +22,14 @@ def test_help():
     )
     print(help)
 
-    readme_md = (Path(__file__).parent.parent.parent / "README.md").read_text()
+    root_path = Path(__file__).parent.parent.parent
+
+    readme_md = (root_path / "README.md").read_text()
     assert help in readme_md
 
+    readme_pypi_md = (root_path / "README-PYPI.md").read_text()
+    assert help in readme_pypi_md
+
 
 def test_arg_validation_no_file():
     with pytest.raises(ArgumentTypeError, match="No such file: no-such-file"):