Skip to content

Add conda dev environment instructions #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 4, 2025
Merged

Add conda dev environment instructions #175

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 31 additions & 7 deletions docs/developers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,10 @@ compassion wins every time.

All contributors are expected to follow our [code of conduct](conduct.md).

## Setup

**You must have recent versions of [Python](https://python.org/),
[node.js](https://nodejs.org/en) and [npm](https://www.npmjs.com/) already
installed on your system.**

## Setup
The following steps create a working development environment for PyScript. It
is through this environment that you contribute to PyScript.
is through this environment that you contribute to PyScript. You can choose
between two options for setting up your environment.

!!! danger

Expand Down Expand Up @@ -89,6 +85,34 @@ is through this environment that you contribute to PyScript.
deactivate
```

### Option 2: Create a conda environment
**This option will install Python and NodeJS for you, so you don't need to have them
pre-installed on your system.**

* If you prefer using [conda](https://docs.conda.io/en/latest/) for environment management,
you can create a conda environment that includes both Python and NodeJS:
*
```sh
conda create --name pyscript python nodejs
conda activate pyscript
```

!!! warning

Replace `pyscript` with a meaningful name for the conda environment, that works for you.

* This creates a new environment with both Python and NodeJS installed. The prompt in your
terminal will change to include the name of your conda environment indicating the sandbox is active.
* To deactivate the conda environment just type the following into your terminal:

```sh
conda deactivate
```

* If you don't have conda installed, you can download and install
[Miniconda, Miniforge](https://docs.conda.io/projects/conda), or
[Anaconda](https://www.anaconda.com/download).

!!! info

The rest of the instructions on this page assume you are working in **an
Expand Down