Skip to content

Commit

Permalink
Update outputs on README to match no-rich output
Browse files Browse the repository at this point in the history
  • Loading branch information
leouieda committed Jan 10, 2022
1 parent edb763d commit 6682aa9
Showing 1 changed file with 59 additions and 35 deletions.
94 changes: 59 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,57 +37,81 @@ conda install dependente -c conda-forge

## Using

> In these examples, we'll parse the dependencies from
> [Pooch](https:/fatiando/pooch).
Parse the install (run-time) dependencies from `setup.cfg`:

```
$ dependente > requirements.txt
πŸš€ Extracting dependencies: install
πŸ”Ž Parsing setup.cfg
- 3 dependencies found
πŸ–¨ Printing 3 dependencies to the standard output stream
πŸ₯³ Done! πŸ₯³
Extracting dependencies: install
Parsing setup.cfg
- 3 dependencies found
Printing 3 dependencies to standard output
Done!
$ cat requirements.txt
# Install (run-time) dependencies from setup.cfg
click>=8.0.0,<9.0.0
rich>=9.6.0,<11.0.0
tomli>=1.1.0,<3.0.0
appdirs>=1.3.0
packaging>=20.0
requests>=2.19.0
```

Pin the dependencies to their oldest supported version (useful for testing
in CI):
Also read the build dependencies from `pyproject.toml` and extra dependencies
from `setup.cfg`:

```
$ dependente --oldest > requirements-oldest.txt
πŸš€ Extracting dependencies: install
πŸ”Ž Parsing setup.cfg
- 3 dependencies found
πŸ•° Pinning dependencies to their oldest versions
πŸ–¨ Printing 3 dependencies to the standard output stream
πŸ₯³ Done! πŸ₯³
$ cat requirements-oldest.txt
$ dependente --source install,build,extras > requirements-all.txt
Extracting dependencies: install,build,extras
Parsing setup.cfg
- 6 dependencies found
Parsing pyproject.toml
- 3 dependencies found
Printing 9 dependencies to standard output
Done!
$ cat requirements-all.txt
# Extra (optional) dependencies from setup.cfg
# extra: progress
tqdm>=4.41.0,<5.0.0
# extra: sftp
paramiko>=2.7.0
# extra: xxhash
xxhash>=1.4.3
# Install (run-time) dependencies from setup.cfg
click==8.0.0
rich==9.6.0
tomli==1.1.0
appdirs>=1.3.0
packaging>=20.0
requests>=2.19.0
# Build dependencies from pyproject.toml
setuptools>=45
wheel
setuptools_scm[toml]>=6.2
```

Read build dependencies from `pyproject.toml`:
Pin the dependencies to their oldest supported version (useful for testing
in CI):

```
$ dependente --source build > requirements-build.txt
πŸš€ Extracting dependencies: build
πŸ”Ž Parsing pyproject.toml
- 3 dependencies found
πŸ–¨ Printing 3 dependencies to the standard output stream
πŸ₯³ Done! πŸ₯³
$ cat requirements-build.txt
# Build dependencies from pyproject.toml
setuptools>=45
setuptools_scm[toml]>=6.2
wheel
$ dependente --source install,extras --oldest > requirements-oldest.txt
Extracting dependencies: install,extras
Parsing setup.cfg
- 6 dependencies found
Pinning dependencies to their oldest versions
Printing 6 dependencies to standard output
Done!
$ cat requirements-oldest.txt
# Extra (optional) dependencies from setup.cfg
# extra: progress
tqdm==4.41.0
# extra: sftp
paramiko==2.7.0
# extra: xxhash
xxhash==1.4.3
# Install (run-time) dependencies from setup.cfg
appdirs==1.3.0
packaging==20.0
requests==2.19.0
```

See a full list of options:
Expand Down

0 comments on commit 6682aa9

Please sign in to comment.