Metadata-Version: 2.4
Name: gitdata-lib
Version: 0.0.20
Summary: Data extraction and analysis library
Home-page: https://github.com/gitdata/gitdata-lib
Author: DSI Labs
Author-email: support@gitdata.com
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Database :: Front-Ends
Requires-Python: >=3.9,<3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: python-decouple>=3.4
Requires-Dist: Unipath>=1.1
Requires-Dist: PyMySQL==0.10.1
Requires-Dist: psycopg2-binary==2.9.10
Requires-Dist: python-dotenv
Requires-Dist: requests
Requires-Dist: docopt-ng<1,>=0.9
Requires-Dist: faker
Requires-Dist: cryptography
Provides-Extra: oracle
Requires-Dist: oracledb<4,>=1.3; extra == "oracle"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# GitData

GitData gives you one set of commands for exploring files and databases.
List what is inside a source with `gitdata ls`, then preview its data with
`gitdata scan`.

## Install

GitData supports Python 3.9 through 3.12.

```bash
python3 -m pip install gitdata-lib
```

Oracle support is optional:

```bash
python3 -m pip install 'gitdata-lib[oracle]'
```

## Explore a data source

The same two commands work across CSV files, SQLite databases,
MariaDB/MySQL databases, and Oracle databases:

```bash
gitdata ls <source>
gitdata scan <source>
```

Use `-l` for a detailed listing, `-a` to include system objects, and `--limit`
to choose how many rows to preview.

## CSV

List the columns in a CSV file:

```bash
gitdata ls examples/locations-headered.csv
```

Preview its rows:

```bash
gitdata scan --limit 10 examples/locations-headered.csv
```

## SQLite

Start with the database file, then move into a table or column:

```bash
# List tables
gitdata ls examples/inspection.sqlite

# Show table details
gitdata ls -l examples/inspection.sqlite/customers

# Preview rows
gitdata scan --limit 5 examples/inspection.sqlite/customers

# Examine one column
gitdata scan --limit 5 examples/inspection.sqlite/customers.email
```

SQLite references follow this shape:

```text
path/to/database.sqlite
path/to/database.sqlite/table
path/to/database.sqlite/table.column
```

## MariaDB and MySQL

Keep passwords in environment variables instead of putting them in database
references. GitData reads `PASSWORD` by default:

```bash
export PASSWORD='your-password'

SERVER='mysql://user@db.example.com'
DATABASE='mysql://user@db.example.com/sales'
TABLE='mysql://user@db.example.com/sales.orders'
```

Explore the server, database, and table with the same commands:

```bash
# List databases
gitdata ls "$SERVER"

# List tables
gitdata ls "$DATABASE"

# Show columns and indexes
gitdata ls -l "$TABLE"

# Preview rows
gitdata scan --limit 10 "$TABLE"
```

MariaDB/MySQL references follow this shape:

```text
mysql://user@host
mysql://user@host/database
mysql://user@host/database.table
```

If the username is omitted, GitData uses the current operating-system username.
Inline passwords, query parameters, and fragment selectors are not accepted.
To use a password variable other than `PASSWORD`, set `GITDATA_PASSWORD_ENV`
to its name:

```bash
export GITDATA_PASSWORD_ENV=MYSQL_PASSWORD
export MYSQL_PASSWORD='your-password'
```

Use `gitdata ls -a` when you also want to see system databases or tables.

### Try the included MariaDB example

The repository includes `examples/mariadb.sql`. Load it into a disposable
MariaDB container:

```bash
docker run --name gitdata-example-mariadb \
  -e MARIADB_ROOT_PASSWORD=example \
  -p 3307:3306 \
  -d mariadb:10.7

until docker exec gitdata-example-mariadb \
  mariadb-admin ping -h 127.0.0.1 -uroot -pexample --silent
do
  sleep 1
done

docker exec -i gitdata-example-mariadb \
  mariadb -uroot -pexample < examples/mariadb.sql

export GITDATA_PASSWORD_ENV=GITDATA_EXAMPLE_PASSWORD
export GITDATA_EXAMPLE_PASSWORD=example
gitdata ls 'mysql://root@127.0.0.1:3307/gitdata_example'
gitdata scan --limit 5 'mysql://root@127.0.0.1:3307/gitdata_example.customers'
```

Remove the example when finished:

```bash
docker rm -f gitdata-example-mariadb
```

## Command reference

```text
gitdata ls <source>          list databases, tables, or columns
gitdata ls -l <source>       show a detailed listing
gitdata ls -a <source>       include system objects
gitdata scan <source>        preview and profile data
gitdata scan --limit N ...   preview at most N rows
```

Run a command with `--help` for all options:

```bash
gitdata ls --help
gitdata scan --help
```

## Oracle

Install the optional Oracle driver, then set the password. GitData reads
`PASSWORD` by default:

```bash
python3 -m pip install 'gitdata-lib[oracle]'
export PASSWORD='your-password'

DATABASE='oracle://app@db.example.com/FREEPDB1'
TABLE="${DATABASE}/orders"
```

Explore the service and its tables with the same commands:

```bash
# List tables owned by the connected user
gitdata ls "$DATABASE"

# Show table counts and sizes
gitdata ls -l "$DATABASE"

# Show column details
gitdata ls -l "$TABLE"

# Preview rows
gitdata scan --limit 10 "$TABLE"
```

Oracle references follow these shapes; port `1521` may be omitted:

```text
oracle://user@host
oracle://user@host:port/service
oracle://user@host:port/service/table
```

When the service is omitted, GitData first tries the username as the service
name. If Oracle does not advertise that service, GitData asks for an explicit
`/service` path.

To use a password variable other than `PASSWORD`, set
`GITDATA_PASSWORD_ENV` to its name:

```bash
export GITDATA_PASSWORD_ENV=ORACLE_PASSWORD
export ORACLE_PASSWORD='your-password'
```

Inline passwords, query parameters, and fragment selectors are not accepted.
Ordinary Oracle table and column names are shown in lowercase. Quoted identifiers
are shown with their double quotes so names that differ only by Oracle quoting
remain distinct; use the displayed spelling as the final path component when
selecting one (the quotes may be URL-encoded as `%22`).
