From d1444f8e094ef11ce4fa6713a521245b68a842d7 Mon Sep 17 00:00:00 2001 From: Seth Michael Larson Date: Fri, 15 May 2020 15:27:41 -0500 Subject: [PATCH] Add Conda Forge installation instructions --- README.md | 30 ++++++++++++++++++++++-------- docs/source/conf.py | 5 +++++ docs/source/index.rst | 14 ++++++++++++++ 3 files changed, 41 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ed53c0e..18f3048 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,21 @@ _Note, this project is still very much a work in progress and in an alpha state;

- + + + + + +
Latest ReleasePyPI - latest release + latest release
Conda Forge + + latest release + +
Package Status @@ -161,16 +170,21 @@ Operations: See [docs](https://eland.readthedocs.io/en/latest) and [demo_notebook.ipynb](https://eland.readthedocs.io/en/latest/examples/demo_notebook.html) for more examples. ## Where to get it -The source code is currently hosted on GitHub at: -https://github.com/elastic/eland -Binary installers for the latest released version are available at the [Python -package index](https://pypi.org/project/eland). +Eland can be installed from [PyPI](https://pypi.org/project/eland) via pip: -```sh -python -m pip install eland +```bash +$ python -m pip install eland ``` +Eland can also be installed from [Conda Forge](https://anaconda.org/conda-forge/eland) with Conda: + +```bash +$ conda install -c conda-forge eland +``` + +The [source code](https://github.com/elastic/eland) is currently available on GitHub. + ## Versions and Compatibility ### Python Version Support diff --git a/docs/source/conf.py b/docs/source/conf.py index 4b96959..a6c6ee3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -104,6 +104,11 @@ exclude_patterns = ["**.ipynb_checkpoints"] # a list of builtin themes. html_theme = "pydata_sphinx_theme" +html_theme_options = { + "external_links": [], + "github_url": "https://github.com/elastic/eland", + "twitter_url": "https://twitter.com/elastic", +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/source/index.rst b/docs/source/index.rst index 9156020..9f57a7a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -17,6 +17,20 @@ eland: pandas-like data analysis toolkit backed by Elasticsearch Where possible the package uses existing Python APIs and data structures to make it easy to switch between Numpy, Pandas, Scikit-learn to their elasticsearch powered equivalents. In general, the data resides in elasticsearch and not in memory, which allows eland to access large datasets stored in elasticsearch. +Installing Eland +~~~~~~~~~~~~~~~~ + +Eland can be installed from `PyPI `_ via pip: + + .. code-block:: bash + + $ python -m pip install eland + +Eland can also be installed from `Conda Forge `_ with Conda: + + .. code-block:: bash + + $ conda install -c conda-forge eland .. toctree:: :maxdepth: 2