1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
|
# Intake: A general interface for loading data

[](https://github.com/intake/intake/actions)
[](http://intake.readthedocs.io/en/latest/?badge=latest)
[](https://gitter.im/ContinuumIO/intake?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Intake is a lightweight set of tools for loading and sharing data in data science projects.
Intake helps you:
* Load data from a variety of formats (see the [current list of known plugins](http://intake.readthedocs.io/en/latest/plugin-directory.html)) into containers you already know, like Pandas dataframes, Python lists, NumPy arrays, and more.
* Convert boilerplate data loading code into reusable Intake plugins
* Describe data sets in catalog files for easy reuse and sharing between projects and with others.
* Share catalog information (and data sets) over the network with the Intake server
Documentation is available at [Read the Docs](http://intake.readthedocs.io/en/latest).
Status of intake and related packages is available at [Status Dashboard](https://intake.github.io/status)
Weekly news about this repo and other related projects can be found on the
[wiki](https://github.com/intake/intake/wiki/Community-News)
Install
-------
Recommended method using conda:
```bash
conda install -c conda-forge intake
```
You can also install using `pip`, in which case you have a choice as to how many of the optional
dependencies you install, with the simplest having least requirements
```bash
pip install intake
```
and additional sections `[server]`, `[plot]` and `[dataframe]`, or to include everything:
```bash
pip install intake[complete]
```
Note that you may well need specific drivers and other plugins, which usually have additional
dependencies of their own.
Development
-----------
* Create development Python environment with the required dependencies, ideally with `conda`.
The requirements can be found in the yml files in the `scripts/ci/` directory of this repo.
* e.g. `conda env create -f scripts/ci/environment-py38.yml` and then `conda activate test_env`
* Install intake using `pip install -e .[complete]`
* Use `pytest` to run tests.
* Create a fork on github to be able to submit PRs.
* We respect, but do not enforce, pep8 standards; all new code should be covered by tests.
|