Skip to content

Commit

Permalink
Merge pull request #137 from ethanwhite/pipx
Browse files Browse the repository at this point in the history
Add pipx installation instructions
  • Loading branch information
garezana authored May 24, 2024
2 parents 80c5c9a + 41dc4e2 commit 68d3085
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,33 @@ Early stage experiment

### Using pip:

From PyPI

```sh
pip install offlinedatasci
```

From GitHub (latest development version)
### Using pipx:

To install just the command line interface (CLI) we recommend [pipx](https://pipx.pypa.io/). [Install pipx](https://pipx.pypa.io/stable/installation/) and then run:

```sh
pipx install offlinedatasci
```

### Installing development versions

#### Directly From GitHub

```sh
pip install git+https://[email protected]/carpentriesoffline/offlinedatasci.git
```

### For local development:
#### Locally

Clone the repository and from the root directory run:

```sh
git clone https://github.com/carpentriesoffline/offlinedatasci.git
cd offlinedatasci
pip install .
```

Expand Down
16 changes: 16 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

offlinedatasci comes with two interfaces, a command line interface and a Python interface.

## Installation

### Using pip:

```sh
pip install offlinedatasci
```

### Using pipx:

To install just the command line interface (CLI) we recommend [pipx](https://pipx.pypa.io/). [Install pipx](https://pipx.pypa.io/stable/installation/) and then run:

```sh
pipx install offlinedatasci
```

## Command line interface

### Installing everything
Expand Down

0 comments on commit 68d3085

Please sign in to comment.