Skip to content

Commit

Permalink
Merge pull request #131 from ethanwhite/docs-python-interface
Browse files Browse the repository at this point in the history
Add Python interface to Getting Started docs
  • Loading branch information
garezana authored May 15, 2024
2 parents f04a201 + 73df12c commit d8d3a19
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,36 @@ offlinedatasci add python-packages package1 package2 ... <path>`

## Python interface

Coming soon!
The Python interface follows a similar structure but calling Python
functions directly rather than through the CLI.

### Import the package

```python
import offlinedatasci as ods
```

### Installing everything

```python
ods.download_all("<path>")
```

### Installing individual components

You can download and configure the different components separately:

- Python: `ods.download_python("<path>")`
- Python packages: `ods.download_python_packages("<path>")`
- R: `ods.download_r("<path>")`
- RStudio: `ods.download_rstudio("<path>")`
- R packages: `ods.download_r_packages("<path>")`
- Lessons: `ods.download_lessons("<path>")`

### Managing R and Python packages

By default offlinedatasci creates local package mirrors of the most common data science packages.
You can add additional packages yourself using the `download_*_packages` functions:

- Install custom R packages: `ods.download_r_packages("<path>", [<packagename>, <packagename>])`
- Install custom Python packages: `ods.download_python_packages("<path>", [<packagename>, <packagename>])`

0 comments on commit d8d3a19

Please sign in to comment.