Metadata-Version: 2.1
Name: datax
Version: 0.0.2
Summary: DataXplorer 
Home-page: https://github.com/Frechetta/DataXplorer
Author: Eric Frechette
Author-email: frechetta93@gmail.com
License: UNKNOWN
Keywords: data search query
Platform: UNKNOWN
Classifier: Programming Language :: Python
Requires-Python: >= 3.7
Description-Content-Type: text/markdown
Requires-Dist: dxql (==0.0.2)
Requires-Dist: click (>=7.0)
Provides-Extra: testing
Requires-Dist: pytest (>=5.0.1) ; extra == 'testing'
Requires-Dist: pytest-cov (>=2.7.1) ; extra == 'testing'
Requires-Dist: codecov (>=2.0.15) ; extra == 'testing'

[![Build Status](https://travis-ci.org/Frechetta/DataXplorer.svg?branch=master)](https://travis-ci.org/Frechetta/DataXplorer) [![codecov](https://codecov.io/gh/Frechetta/DataXplorer/branch/master/graph/badge.svg)](https://codecov.io/gh/Frechetta/DataXplorer)

# DataXplorer

Requires Python 3.7

Install with `pip install datax`, then run with `dx [OPTIONS] [FILES]...`.

Options:
```
  -v, --verbose      Print verbose messages.
  -i, --interactive  Enter into an interactive loop to query data.
  -q, --query TEXT   The query string.
  --help             Show this message and exit.
```

Example:

`dx -q "search n>5" file.txt`

where `file.txt` looks like

```
{"event": 1, "n": "2", "ip": 7, "type": "geoip"}
{"event": 2, "n": "6", "ip": 10, "type": "geoip"}
{"event": 3, "n": "8", "ip": 15, "type": "geoip"}
```

`-q TEXT` is not required if using interactive mode (`-i`). When in interactive mode, you will enter an input loop, allowing you to repeatedly query data without having to execute the command again. This is faster because the data is kept in memory and doesn't have to be loaded from disk each query. Type `exit`, `quit`, or enter `CTRL+C` to quit. Type `search <query-string>` to search the data. If the `-q` and `-i` options are used together, the query will be executed, results will be printed, then you will enter into an input loop.

DataXplorer also accepts data from a pipe. Example: `cat file.txt | dx -q "search n>5"`.

DataXplorer uses [DXQL](https://github.com/Frechetta/DXQL) to search through the data. See the DXQL readme to learn how to search.


