Skip to content

doc: explain how to install from source #145

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

Open
thiswillbeyourgithub wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: explain how to install from source #145

Show file tree
Hide file tree
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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ PubChemPy provides a way to interact with PubChem in Python. It allows chemical

## Installation

To get the latest version, it is recommended to install from the source directly:
```shell
pip install git+https://github.com/mcs07/PubChemPy
```

This version is not guaranteed to be stable, but may include new features and bug fixes that have not yet been released.

*Note: If you installed PubChemPy from pypi in the passed, you must uninstall it before installing the source code version using `pip uninstall pubchempy` for example*

Install PubChemPy with pip:

```shell
Expand Down
13 changes: 11 additions & 2 deletions docs/guide/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,25 @@ conda install -c conda-forge pubchempy

The conda-forge channel is a community-driven collection of conda packages that provides up-to-date and well-maintained packages for the conda package manager.

## Option 3: Clone the repository
## Option 3: Install from the source code

The latest development version of PubChemPy is always [available on GitHub]. This version is not guaranteed to be stable, but may include new features that have not yet been released. Simply clone the repository and install as usual:
The latest development version of PubChemPy is always [available on GitHub]. This version is not guaranteed to be stable, but may include new features and bug fixes that have not yet been released.

```shell
pip install git+https://github.com/mcs07/PubChemPy
```


Or manually: clone the repository and install as usual:

```shell
git clone https://github.com/mcs07/PubChemPy.git
cd PubChemPy
pip install .
```

*Note: If you installed PubChemPy from pypi in the passed, you must uninstall it before installing the source code version using `pip uninstall pubchempy` for example*

[anaconda]: https://www.anaconda.com/download
[available on github]: https://github.com/mcs07/PubChemPy
[download the latest release]: https://github.com/mcs07/PubChemPy/releases/
Expand Down