Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
torrua committed Mar 6, 2024
1 parent 5879ad2 commit 2fa1c5c
Showing 1 changed file with 36 additions and 10 deletions.
46 changes: 36 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,46 @@
[![Pylint App](https://github.com/torrua/loglan_convert/actions/workflows/pylint_app.yml/badge.svg)](https://github.com/torrua/loglan_convert/actions/workflows/pylint_app.yml)
[![BlackLint](https://github.com/torrua/loglan_convert/actions/workflows/black.yml/badge.svg)](https://github.com/torrua/loglan_convert/actions/workflows/black.yml)

# Supporting databases
postgres, access, text
## Supporting data types
postgres database, access mdb file, text files

# Usage
## Usage
Run your terminal app with following command

```bash
python convert.py --from-type db_type --from-path FROM_PATH --to-type db_type --to-path TO_PATH
python convert.py [-h] {postgres,access,text} from_path {postgres,access,text} to_path
```
# Options
## Positional Arguments
```
-h, --help show this help message and exit
--from-type {postgres,access,text} source type
--from-path FROM_PATH source path
--to-type {postgres,access,text} destination type
--to-path TO_PATH destination path
{postgres,access,text} source type
from_path source path
{postgres,access,text} destination type
to_path destination path
```

## Options
```
-h, --help show this help message and exit
```

# Download data from GitHub source

Supporting data types
Empty Access database file, Filled Access database file, Text files

## Usage
Run your terminal app with following command
```
python download.py [-h] {text,empty-mdb,filled-mdb} url to-path
```

## Positional Arguments
```
{text,empty-mdb,filled-mdb} type of downloading
url URL of the file to download
to-path output directory for the downloaded file
```
## Options
```
-h, --help show this help message and exit
```

0 comments on commit 2fa1c5c

Please sign in to comment.