Skip to content

Commit 128fbdd

Browse files
committed
added test
1 parent 5ad6421 commit 128fbdd

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

docs/pages/usage.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,38 +17,38 @@ It offers functionalities to download datasets, load them into Python environmen
1717
<p>$ python --version</p>
1818
<p>Python 3.13.1</p>
1919
</div>
20-
```
20+
2121
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.
2222

2323
The preferred way to install `coderdata` is via `pip`. Executing the command below will install the most recent published version of `coderdata` including all required dependencies.
24-
```shell
25-
$ pip install coderdata
26-
```
24+
<div class="code-block">
25+
<p>$ pip install coderdata</p>
26+
</div>
2727

2828
To check if the package has been sucessfully installed open an interactive python termial and import the package. See an example of what to expect below.
29-
```python
30-
>>> import coderdata as cd
31-
>>> cd.__version__
32-
'0.1.40'
33-
```
29+
<div class="code-block">
30+
<p>\>\>\> import coderdata as cd</p>
31+
<p>\>\>\> cd.__version__</p>
32+
<p>'0.1.40'</p>
33+
</div>
3434

3535
## Usage
3636
The primary way to interact with coderdata is through the `coderdata` API. Additionally a command line interface with limited functionality (primarily to download data) is also available.
3737

3838
### CLI
3939
Invoking `coderdata` from the command line will by default print a help / usage message and exit (see below):
4040
<div class="code-block">
41-
<p>$ coderdata</p>
42-
<p>usage: coderdata [-h] [-l | -v] {download} ...</p>
43-
<p></p>
44-
<p>options:</p>
45-
<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>
41+
<p>$ coderdata</p>
42+
<p>usage: coderdata [-h] [-l | -v] {download} ...</p>
43+
<p></p>
44+
<p>options:</p>
45+
<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>
5252
</div>
5353

5454

0 commit comments

Comments
 (0)