Add Conda Forge installation instructions

This commit is contained in:
Seth Michael Larson 2020-05-15 15:27:41 -05:00 committed by GitHub
parent 6ca41585e9
commit d1444f8e09
3 changed files with 41 additions and 8 deletions

View File

@ -7,12 +7,21 @@ _Note, this project is still very much a work in progress and in an alpha state;
</p>
<table>
<tr>
<td>Latest Release</td>
<td>PyPI</td>
<td>
<a href="https://pypi.org/project/eland/">
<img src="https://img.shields.io/pypi/v/eland.svg" alt="latest release" />
<img src="https://img.shields.io/pypi/v/eland.svg" alt="latest release"/>
</a>
</td>
</tr>
<tr>
<td>Conda Forge</td>
<td>
<a href="https://anaconda.org/conda-forge/eland">
<img src="https://img.shields.io/conda/vn/conda-forge/eland" alt="latest release"/>
</a>
</td>
</tr>
<tr>
<td>Package Status</td>
<td>
@ -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

View File

@ -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,

View File

@ -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 <https://pypi.org/project/eland>`_ via pip:
.. code-block:: bash
$ python -m pip install eland
Eland can also be installed from `Conda Forge <https://anaconda.org/conda-forge/eland>`_ with Conda:
.. code-block:: bash
$ conda install -c conda-forge eland
.. toctree::
:maxdepth: 2