Skip to content

Commit

Permalink
Improve developer install docs. (#386)
Browse files Browse the repository at this point in the history
* Improve developer install docs.

* Small tidy ups.

* Unpin python from 3.10 in instructions, quick tidy up on dev tab.
  • Loading branch information
JoeZiminski authored May 17, 2024
1 parent 6dd002f commit f53f91d
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions docs/source/pages/how_tos/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Next, create and activate an environment. You can call your environment whateve
we've used `datashuttle-env`:

```sh
conda create -n datashuttle-env python=3.10
conda create -n datashuttle-env
conda activate datashuttle-env
```

Expand All @@ -56,16 +56,33 @@ pip install datashuttle
:::

:::{tab-item} Developers
To get the latest development version, clone the

`pip` must be used to install developer dependencies.
As
[Rclone](https://rclone.org/)
is not available through `pip`, you can install `Rclone` with `Conda`

```sh
conda install -c conda-forge rclone
```

or using the [RClone's standalone installer](https://rclone.org/downloads/).

Next, clone the **datashuttle**
[GitHub repository](https://github.com/neuroinformatics-unit/datashuttle/)
and then run from inside the repository
to get the latest development version.

To install **datashuttle** and its developer dependencies,
run the follow command from inside the repository:

```sh
pip install -e .[dev] # works on most shells
pip install -e '.[dev]' # works on zsh (the default shell on macOS)
```

This will install the package in editable mode, including all `dev` dependencies.
This will install an 'editable' version of **datashuttle**, meaning
any changes you make to the cloned code will be immediately
reflected in the installed package.
:::

::::
Expand Down

0 comments on commit f53f91d

Please sign in to comment.