search

pyOpenSci / python-package-guide

scientific Python package recommendations & guidance curated by pyOpenSci
https://www.pyopensci.org/python-package-guide/
Other
70 stars 43 forks source link

Potential Addition to Step 5: Activating Environment - More Info #263

Open BSuperbad opened 1 month ago

BSuperbad commented 1 month ago

Describe the bug In "Step 5: Install your package locally," it might be nice to add steps on how to install conda or venv like how you did with installing pipx. Right now, it has code on how to set up the conda virtual environment, but it doesn't offer a link to download conda.

Also, it might be nice to show how to activate using both venv or conda options. (venv): $ python3 -m venv venv $ source venv/bin/activate

Link: https://www.pyopensci.org/python-package-guide/tutorials/installable-code.html#step-5-install-your-package-locally

How to reproduce (without having conda installed on macOS): $ conda activate pyosdev zsh: command not found: conda

pb-413 commented 1 month ago

The steps you outlined regarding venv are similar to the steps I used.

The following issues are also related to mentioning python (virtual) environments:

254

258

I agree that we should point to external documentation like venv - Creation of virtual environments or create internal docs/explanations.