You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/pages/usage.md
+17-15Lines changed: 17 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,10 @@ It offers functionalities to download datasets, load them into Python environmen
13
13
14
14
## Installation
15
15
`coderdata` requires `python>=3.9` to be installed. The installed version can be checked via
16
-
```shell
17
-
$ python --version
18
-
Python 3.13.1
16
+
<divclass="code-block">
17
+
<p>$ python --version</p>
18
+
<p>Python 3.13.1</p>
19
+
</div>
19
20
```
20
21
If a Python version older that 3.9 is installed please referr to the instruction at [python.org](https://www.python.org/about/gettingstarted/#installing) on how to install / update Python.
21
22
@@ -36,19 +37,20 @@ The primary way to interact with coderdata is through the `coderdata` API. Addit
36
37
37
38
### CLI
38
39
Invoking `coderdata` from the command line will by default print a help / usage message and exit (see below):
<p> -h, --help show this help message and exit</p>
46
+
<p> -l, --list prints list of available datasets and exits program.</p>
47
+
<p> -v, --version prints the versions of the coderdata API and dataset and exits the program</p>
48
+
<p></p>
49
+
<p>commands:</p>
50
+
<p> {download}</p>
51
+
<p> download subroutine to download datasets. See "coderdata download -h" for more options.</p>
52
+
</div>
42
53
43
-
options:
44
-
-h, --help show this help message and exit
45
-
-l, --list prints list of available datasets and exits program.
46
-
-v, --version prints the versions of the coderdata API and dataset and exits the program
47
-
48
-
commands:
49
-
{download}
50
-
download subroutine to download datasets. See "coderdata download -h"for more options.
51
-
```
52
54
53
55
The primary use case of the CLI is to retrieve dataset from the repository. This can be done by invoking the `download` routine of `coderdata`. Without defining a specific dataset the whole repository will be downloaded:
0 commit comments