dbnet-python

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 8 Open GitHub ↗

A Python/VueJS database client (Web GUI) to access Oracle, Spark (Hive), Postgres, etc.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

DbNet is a Python/VueJS database client to access Oracle, Spark (Hive), Postgres, etc. It is still a work in progess, but should work fine for daily use. MS SQL Server is supported, although with some bugs here and there due to JDBC/JTDS bridge.

**Only Chrome and Firefox are supported at the moment.**

# Running with Docker

`docker run --rm -it -p 5566:5566 -v $HOME/dbnet:/root/dbnet flarco/dbnet --serve`

# Running with python
```bash
pip install dbnet
```

Command `dbnet` should now be available in the PATH.

`dbnet --help`

```bash
usage: dbnet [-h] [--serve] [--init_db] [--reset_db] [--force] [--port PORT]

DbNet Application

optional arguments:
  -h, --help   show this help message and exit
  --serve      Start the DbNet server
  --init_db    Initiatlize the backend SQLite database
  --reset_db   Reset the backend SQLite database
  --force      Kill any running instance.
  --port PORT  The web application port
```

`dbnet --serve`

```bash
2019-02-27 10:08:11 -- DB Tables OK.
2019-02-27 10:08:11 -- Main Loop PID is 39685
2019-02-27 10:08:11 -- Monitor Loop PID is 39691
2019-02-27 10:08:11 -- Web Server PID is 39692
2019-02-27 10:08:11 -- URL -> http://macbook:5566/?token=CqPahSJIeg1Nl4Kj
(39692) wsgi starting up on http://0.0.0.0:5566
```

## Setting up Dababase Profile

Your database profile / credentials needs to be set up at `~/profile.yaml` or env var `PROFILE_YAML`.
Run command `xutil-create-profile` to create from template.

### Example Entry

```yaml
PG_XENIAL:
  name: PG_XENIAL
  host: xenial-server
  database: db1
  port: 5432
  user: user
  password: password
  type: postgresql
  jdbc_url: "jdbc:postgresql://xenial-server:5432/db1?&ssl=false"
```

## Environment variables

- `DBNET_WEBAPP_PORT` = Web application port (default is `5566`)
- `DBNET_WEBAPP_HOST` = Web application host (default is `0.0.0.0`)
- `DBNET_PASSWD` = password to access application (default is random string)
- `DBNET_WORKER_PREFIX` = database worker name prefix (default is `dbnet`)
- `DBNET_FOLDER` = local storage / queries folder (default `~/dbnet`) 
- `DBNET_MAX_WORKER_PER_DB` = the maximum number of workers per database (default is `3`)
- `DBNET_APPRISE_URL` = the [apprise](https://github.com/caronc/apprise) URL to send notifications to.
- `DBNET_DB_URL` = the database URL to connect to (only one DB).

# Screenshots

![Screenshot 2](https://raw.githubusercontent.com/flarco/dbnet-python/master/dbnet.screenshot.2.png)

![Screenshot 1](https://raw.githubusercontent.com/flarco/dbnet-python/master/dbnet.screenshot.1.png)

# Development

## Install Vue & Dependencies

```bash
npm install -g @vue/cli @vue/cli-service @vue/cli-plugin-babel @vue/cli-plugin-eslint
git clone https://github.com/flarco/dbnet.git
cd dbnet/frontend
npm install
```

## Building

```bash
git clone https://github.com/flarco/dbnet.git
cd dbnet
bash build.sh
```

## Release

- Update version in [setup.py](./setup.py).
- Draft new release on Github: <https://github.com/flarco/dbnet/releases/new>

```
git clone https://github.com/flarco/dbnet.git
cd dbnet
m2r --overwrite README.md
python setup.py sdist && twine upload --skip-existing dist/*
```

dbnet-python

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README