Skip to content

Commit

Permalink
Release 1.1 doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
CSLukeW committed Jun 24, 2020
1 parent 258fad2 commit 94b48ec
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,21 @@ pip install cssaw-central

## Usage

### csvsql script

The package comes with a script to automatically upload a csv file to the given table in a sql database. It takes user, pass, host IP, database, table, and cSV file path as arguments

#### example
``` Bash
csvsql test test HOST Test test_table ./TestDocs/test.csv
```

The above example connects to the Test database using the test user and inserts the test.csv file into test_table.

### Session module
Session object acts as a wrapper for sqlalchemy connection. The connection is created and stored in the Session object at initialization, and any results can be taken from the self.conn object or, if using execute_sql(), can be taken from the returned results python list.

### Example:
#### Example:
```Python
from cssaw_central import Session

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setuptools.setup(
name="cssaw_central",
version="1.0.0",
version="1.1.0",
author="Luke Williams",
author_email="[email protected]",
description="Access Point Module to CSSAW Database",
Expand Down

0 comments on commit 94b48ec

Please sign in to comment.