docstring_parser icon indicating copy to clipboard operation
docstring_parser copied to clipboard

Add published package installation to README

Open jspaezp opened this issue 3 years ago • 1 comments

Hey there!

This project looks amazing, I am very excited to try it out. I was wondering what you thought about adding to the readme the basic installation instructions from the releases?

maybe something as ... installation: pip install docstring_parser to make clear it is pypi-published. Maybe also reference the conda forge package?

@Chilipp How is that done? im not a conda user ...

Thanks a lot! LMK if you want me to make it a super simple PR

jspaezp avatar Sep 17 '22 00:09 jspaezp

Sure, let's add it. LMK once you create a PR.

rr- avatar Sep 17 '22 11:09 rr-

hey @jspaezp! Installation via conda requires two steps:

  1. download and install miniconda or anaconda
  2. install the package from the conda-forge channel via conda install -c conda-forge docstring_parser or create a new conda environment via conda create -n my-new-environment -c conda-forge docstring_parser

Chilipp avatar Sep 17 '22 14:09 Chilipp

Thanks a lot for the reply!

Made a PR https://github.com/rr-/docstring_parser/pull/74

jspaezp avatar Sep 17 '22 19:09 jspaezp

The PR was merged.

rr- avatar Sep 18 '22 09:09 rr-