diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a6598459..ad2ce1a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,3 +73,6 @@ make html This generates all the HTML documentation files in `doc/_build/html/`. The configuration file `conf.py` contains information related to Sphinx settings. The Sphinx documentations are written as ReStructuredText (`*.rst` files) and mostly stored in the `source/` folder. The documentation inside `source/reference` is auto-generated by Sphinx. The repository is linked with [ReadTheDocs](https://readthedocs.org/projects/lux-api/), which triggers the build for the latest documentation based on the most recent commit. As a result, we do not commit anything inside `doc/_build` in the Github repository. +# Updating the Conda Recipe + +In order to update the conda recipe on conda forge, you can follow the steps [here](https://conda-forge.org/#update_recipe). The conda recipe needs to be updated when either a new dependency is added or when the version number needs to be updated in the case of a new release. diff --git a/README.md b/README.md index 0899ea35..693a6e76 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Mailing List - + Binder @@ -32,7 +32,7 @@ Lux is a Python library that makes data science easier by automating aspects of Here is a [1-min video](https://www.youtube.com/watch?v=qmnYP-LmbNU) introducing Lux, and [slides](http://dorisjunglinlee.com/files/Zillow_07_2020_Slide.pdf) from a more extended talk. -Try out Lux on your own in a live Jupyter Notebook [here](https://mybinder.org/v2/gh/lux-org/lux-binder/master?urlpath=tree/demo/cars_demo.ipynb)! +Try out Lux on your own in a live Jupyter Notebook [here](https://mybinder.org/v2/gh/lux-org/lux-binder/master?urlpath=lab/tree/demo/cars_demo.ipynb)! # Getting Started @@ -139,7 +139,13 @@ To get started, Lux can be installed through [PyPI](https://pypi.org/project/lux pip install lux-api ``` -This installation includes the Lux Jupyter widget frontend, [lux-widget](https://pypi.org/project/lux-widget/). +If you use [conda](https://docs.conda.io/en/latest/), you can install Lux via: + +```bash +conda install -c conda-forge lux-api +``` + +Both the PyPI and conda installation include includes the Lux Jupyter widget frontend, [lux-widget](https://pypi.org/project/lux-widget/). ## Setup in Jupyter Notebook, VSCode diff --git a/conda.recipe/meta.yaml b/conda.recipe/meta.yaml new file mode 100644 index 00000000..33e43a36 --- /dev/null +++ b/conda.recipe/meta.yaml @@ -0,0 +1,43 @@ +{% set name = "lux-api" %} +{% set version = "0.2.2" %} + + +package: + name: {{ name|lower }} + version: {{ version }} + +source: + url: https://pypi.io/packages/source/{{ name[0] }}/{{ name }}/lux-api-{{ version }}.tar.gz + sha256: 01c5605a16b6130f159ab7d1d9d4ffd6fdc49ea854d9ab0f6481194e701c4a1f + +build: + number: 0 + noarch: python + script: {{ PYTHON }} -m pip install . -vv + +requirements: + host: + - pip + - python >=3.6 + run: + - python >=3.6 + - scipy >=1.3.3 altair>=4.0.0 numpy>=1.16.5 pandas>=1.1.0 scikit-learn>=0.22 + +test: + imports: + - lux + - lux._config + commands: + - pip check + requires: + - pip + +about: + home: https://github.com/lux-org/lux + summary: A Python API for Intelligent Data Discovery + license: Apache-2.0 + license_file: LICENSE + +extra: + recipe-maintainers: + - dorisjlee