Skip to content

Commit b78a860

Browse files
committed
Revise description: Hopefully provide the information people need?
1 parent a8b9045 commit b78a860

2 files changed

Lines changed: 21 additions & 19 deletions

File tree

README-PYPI.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,18 @@
22

33
[![pypi](https://img.shields.io/pypi/v/dp_wizard)](https://pypi.org/project/dp_wizard/)
44

5-
Building on what we've learned from [DP Creator](https://github.com/opendp/dpcreator), DP Wizard offers:
6-
7-
- Easy installation with `pip install dp_wizard[app]`
8-
- Simplified single-user application design
9-
- Streamlined workflow that doesn't assume familiarity with differential privacy
10-
- Interactive visualization of privacy budget choices
11-
- UI development in Python with [Shiny](https://shiny.posit.co/py/)
5+
DP Wizard makes it easier to get started with differential privacy.
126

137
You can run DP Wizard locally and upload your own CSV,
14-
or use the [cloud deployment](https://01966942-7eab-da99-0887-a7c483756aa8.share.connect.posit.cloud/) and only provide column names to protect your private data.
15-
In either case, you'll be prompted to describe the analysis you need, and then be able to download outputs including:
8+
or use the [cloud deployment](https://mccalluc-dp-wizard.share.connect.posit.cloud/) and only provide column names to protect your private data.
9+
In either case, you'll be prompted to describe your privacy budget and the analysis you need, including:
10+
11+
- Grouping
12+
- DP means, medians, and histograms
1613

17-
- A Jupyter notebook which demonstrates how to use [OpenDP](https://docs.opendp.org/).
14+
With that information, DP Wizard provides
15+
16+
- A Jupyter notebook which demonstrates how to use the [OpenDP](https://docs.opendp.org/) library.
1817
- A plain Python script.
1918
- Text and CSV reports.
2019

@@ -24,6 +23,8 @@ DP Wizard requires Python 3.10 or later.
2423
You can check your current version with `python --version`.
2524
The exact upgrade process will depend on your environment and operating system.
2625

26+
Install with `pip install dp_wizard[app]` and you can start DP Wizard from the command line.
27+
2728
```
2829
usage: dp-wizard [-h] [--demo | --cloud]
2930

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,18 @@
22

33
[![pypi](https://img.shields.io/pypi/v/dp_wizard)](https://pypi.org/project/dp_wizard/)
44

5-
Building on what we've learned from [DP Creator](https://github.com/opendp/dpcreator), DP Wizard offers:
6-
7-
- Easy installation with `pip install dp_wizard[app]`
8-
- Simplified single-user application design
9-
- Streamlined workflow that doesn't assume familiarity with differential privacy
10-
- Interactive visualization of privacy budget choices
11-
- UI development in Python with [Shiny](https://shiny.posit.co/py/)
5+
DP Wizard makes it easier to get started with differential privacy.
126

137
You can run DP Wizard locally and upload your own CSV,
148
or use the [cloud deployment](https://mccalluc-dp-wizard.share.connect.posit.cloud/) and only provide column names to protect your private data.
15-
In either case, you'll be prompted to describe the analysis you need, and then be able to download outputs including:
9+
In either case, you'll be prompted to describe your privacy budget and the analysis you need, including:
10+
11+
- Grouping
12+
- DP means, medians, and histograms
1613

17-
- A Jupyter notebook which demonstrates how to use [OpenDP](https://docs.opendp.org/).
14+
With that information, DP Wizard provides
15+
16+
- A Jupyter notebook which demonstrates how to use the [OpenDP](https://docs.opendp.org/) library.
1817
- A plain Python script.
1918
- Text and CSV reports.
2019

@@ -24,6 +23,8 @@ DP Wizard requires Python 3.10 or later.
2423
You can check your current version with `python --version`.
2524
The exact upgrade process will depend on your environment and operating system.
2625

26+
Install with `pip install dp_wizard[app]` and you can start DP Wizard from the command line.
27+
2728
```
2829
usage: dp-wizard [-h] [--demo | --cloud]
2930

0 commit comments

Comments
 (0)