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
+20-20Lines changed: 20 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -17,38 +17,38 @@ It offers functionalities to download datasets, load them into Python environmen
17
17
<p>$ python --version</p>
18
18
<p>Python 3.13.1</p>
19
19
</div>
20
-
```
20
+
21
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.
22
22
23
23
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
+
<divclass="code-block">
25
+
<p>$ pip install coderdata</p>
26
+
</div>
27
27
28
28
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
+
<divclass="code-block">
30
+
<p>\>\>\> import coderdata as cd</p>
31
+
<p>\>\>\> cd.__version__</p>
32
+
<p>'0.1.40'</p>
33
+
</div>
34
34
35
35
## Usage
36
36
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.
37
37
38
38
### CLI
39
39
Invoking `coderdata` from the command line will by default print a help / usage message and exit (see below):
0 commit comments