From e9a9c39cf58169afaec3246668f1da1a17dfe2d5 Mon Sep 17 00:00:00 2001 From: thiswillbeyourgithub <26625900+thiswillbeyourgithub@users.noreply.github.com> Date: Wed, 3 Sep 2025 12:52:42 +0200 Subject: [PATCH] doc: explain how to install from source Signed-off-by: thiswillbeyourgithub <26625900+thiswillbeyourgithub@users.noreply.github.com> --- README.md | 9 +++++++++ docs/guide/install.md | 13 +++++++++++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d941e7d..5873a05 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/guide/install.md b/docs/guide/install.md index a409044..f7ffa6c 100644 --- a/docs/guide/install.md +++ b/docs/guide/install.md @@ -28,9 +28,16 @@ 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 @@ -38,6 +45,8 @@ 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/