Skip to content

Commit 6682aa9

Browse files
committed
Update outputs on README to match no-rich output
1 parent edb763d commit 6682aa9

File tree

1 file changed

+59
-35
lines changed

1 file changed

+59
-35
lines changed

README.md

Lines changed: 59 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -37,57 +37,81 @@ conda install dependente -c conda-forge
3737

3838
## Using
3939

40+
> In these examples, we'll parse the dependencies from
41+
> [Pooch](https://github.com/fatiando/pooch).
42+
4043
Parse the install (run-time) dependencies from `setup.cfg`:
4144

4245
```
4346
$ dependente > requirements.txt
44-
🚀 Extracting dependencies: install
45-
🔎 Parsing setup.cfg
46-
- 3 dependencies found
47-
🖨 Printing 3 dependencies to the standard output stream
48-
🥳 Done! 🥳
47+
Extracting dependencies: install
48+
Parsing setup.cfg
49+
- 3 dependencies found
50+
Printing 3 dependencies to standard output
51+
Done!
4952
5053
$ cat requirements.txt
5154
# Install (run-time) dependencies from setup.cfg
52-
click>=8.0.0,<9.0.0
53-
rich>=9.6.0,<11.0.0
54-
tomli>=1.1.0,<3.0.0
55+
appdirs>=1.3.0
56+
packaging>=20.0
57+
requests>=2.19.0
5558
```
5659

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

6063
```
61-
$ dependente --oldest > requirements-oldest.txt
62-
🚀 Extracting dependencies: install
63-
🔎 Parsing setup.cfg
64-
- 3 dependencies found
65-
🕰 Pinning dependencies to their oldest versions
66-
🖨 Printing 3 dependencies to the standard output stream
67-
🥳 Done! 🥳
68-
69-
$ cat requirements-oldest.txt
64+
$ dependente --source install,build,extras > requirements-all.txt
65+
Extracting dependencies: install,build,extras
66+
Parsing setup.cfg
67+
- 6 dependencies found
68+
Parsing pyproject.toml
69+
- 3 dependencies found
70+
Printing 9 dependencies to standard output
71+
Done!
72+
73+
$ cat requirements-all.txt
74+
# Extra (optional) dependencies from setup.cfg
75+
# extra: progress
76+
tqdm>=4.41.0,<5.0.0
77+
# extra: sftp
78+
paramiko>=2.7.0
79+
# extra: xxhash
80+
xxhash>=1.4.3
7081
# Install (run-time) dependencies from setup.cfg
71-
click==8.0.0
72-
rich==9.6.0
73-
tomli==1.1.0
82+
appdirs>=1.3.0
83+
packaging>=20.0
84+
requests>=2.19.0
85+
# Build dependencies from pyproject.toml
86+
setuptools>=45
87+
wheel
88+
setuptools_scm[toml]>=6.2
7489
```
7590

76-
Read build dependencies from `pyproject.toml`:
91+
Pin the dependencies to their oldest supported version (useful for testing
92+
in CI):
7793

7894
```
79-
$ dependente --source build > requirements-build.txt
80-
🚀 Extracting dependencies: build
81-
🔎 Parsing pyproject.toml
82-
- 3 dependencies found
83-
🖨 Printing 3 dependencies to the standard output stream
84-
🥳 Done! 🥳
85-
86-
$ cat requirements-build.txt
87-
# Build dependencies from pyproject.toml
88-
setuptools>=45
89-
setuptools_scm[toml]>=6.2
90-
wheel
95+
$ dependente --source install,extras --oldest > requirements-oldest.txt
96+
Extracting dependencies: install,extras
97+
Parsing setup.cfg
98+
- 6 dependencies found
99+
Pinning dependencies to their oldest versions
100+
Printing 6 dependencies to standard output
101+
Done!
102+
103+
$ cat requirements-oldest.txt
104+
# Extra (optional) dependencies from setup.cfg
105+
# extra: progress
106+
tqdm==4.41.0
107+
# extra: sftp
108+
paramiko==2.7.0
109+
# extra: xxhash
110+
xxhash==1.4.3
111+
# Install (run-time) dependencies from setup.cfg
112+
appdirs==1.3.0
113+
packaging==20.0
114+
requests==2.19.0
91115
```
92116

93117
See a full list of options:

0 commit comments

Comments
 (0)