Skip to content

Fix example code and add Debian setup instructions #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix example code and add Debian setup instructions #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,20 @@ database (`.rdb`) as a [Pandas](http://pandas.pydata.org/)
## Installation

To read the database, this package (thinly!) wraps
[MDBTools](http://mdbtools.sourceforge.net/). Since I assume you're already
[MDBTools](https://github.com/mdbtools/mdbtools). Since I assume you're already
using Pandas, it should be your only installation requirement.

If you are on `OSX`, install it via [Homebrew](http://brew.sh/):

```sh
$ brew install mdbtools
```

If you are on `Debian`, install it via apt:
```sh
$ sudo apt install mdbtools
```

Then, do,
```sh
$ pip install pandas_access
Expand All @@ -24,18 +30,18 @@ $ pip install pandas_access
## Usage

```python
import pandas_access as mdb
import pandas_access as pd_access

# Listing the tables.
for tbl in mdb.list_tables("my.mdb"):
for tbl in pd_access.list_tables("my.mdb"):
print(tbl)

# Read a small table.
df = pandas_access.read_table("my.mdb", "MyTable")
df = pd_access.read_table("my.mdb", "MyTable")

# Read a huge table.
accumulator = []
for chunk in pandas_access.read_table("my.mdb", "MyTable", chunksize=10000):
for chunk in pd_access.read_table("my.mdb", "MyTable", chunksize=10000):
accumulator.append(f(chunk))
```

Expand Down