Metadata-Version: 2.1
Name: lumicks-doltcli
Version: 0.2.1
Summary: Slim Python interface for Dolt's CLI API.
Author: Max Hoffman
Author-email: max@dolthub.com
Requires-Python: >=3.8
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown

# DoltCLI

This is a minimalist package intended for data engineering applications:

- Unzipped size ~100kb
- One dependency -- Dolt binary
- Only changes when Dolt changes

If you are a data scientist or are using Pandas there are three options:
- Use [doltpy](https://github.com/dolthub/doltpy)
- Use [pandas.sql](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_sql.html)
  with [dolt
  sql-server](https://docs.dolthub.com/interfaces/cli#dolt-sql-server)
- Manually convert the `doltcli` return types to DataFrames with
  `pd.Dataframe.from_records(...)` or another [DataFrame instantiate of
  choice](https://pandas.pydata.org/pandas-docs/version/0.18.1/generated/pandas.DataFrame.html).

Note: `doltcli` is in development. The interface does not
completely wrap Dolt CLI yet, and may have function signature changes in
the short-term. Reach out to the team on our discord if you have
questions regarding production use-cases.

## Dev Setup

- clone repo
- Python 3.6+ required
- [Install Dolt binary](https://docs.dolthub.com/introduction/installation)
- [Install Poetry](https://python-poetry.org/docs/#installation)
```bash
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
```
 - Install dependencies:
```bash
poetry install
```

Now you can run tests and use `doltcli`.

