Skip to content

Commit 128e939

Browse files
committed
update readme with template
1 parent c6780d4 commit 128e939

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,18 @@ You can install Pasteur with pip.
2222
pip install pasteur
2323
```
2424

25-
By default, Pasteur is disabled. To use it with a kedro project, add the
26-
`PASTEUR_MODULES` keyword in your `settings.py` file, which will enable it.
27-
```python
28-
from pasteur.extras import get_recommended_modules
29-
30-
PASTEUR_MODULES = get_recommended_modules()
25+
Following, you can create a Pasteur project with:
26+
```bash
27+
pasteur new --starter=pasteur
3128
```
3229

33-
Currently, there does not exist a template project from which to start upon.
34-
This repository is a working Pasteur project and is what was used to develop it.
35-
The module `./src/project` is a kedro project with configs in `./conf` and it is
36-
the one that was used to develop pasteur.
30+
The `pasteur` command is aliased to `kedro`, so you can use them interchangeably.
31+
Within your new project, you can now begin working with Pasteur.
32+
```bash
33+
pasteur download --accept adult
34+
pasteur p adult.ingest
35+
pasteur p tab_adult.privbayes --synth
36+
```
3737

3838
## Contributing
3939
To contribute, clone this repository and install the frozen requirements.

0 commit comments

Comments
 (0)