Skip to content

Commit

Permalink
Merge pull request #66 from vluzko/documentation
Browse files Browse the repository at this point in the history
Simple workflow example. Closes #57
  • Loading branch information
vluzko authored Aug 16, 2022
2 parents fac7e66 + e754032 commit d0bb6ee
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ A reimplementation of [auk](https://github.com/CornellLabofOrnithology/auk) in P
Note that this is *not* a direct port: aukpy does not use `awk` to access data. Instead it provides a similar API, but uses sqlite to index and query the dataset.

For detailed usage, [see the full documentation](https://aukpy.readthedocs.io/en/latest/)

## Usage
To load and filter a set of eBird observations stored in `observations.txt`:
```
from aukpy import db, queries
db_conn = db.build_db_pandas('observations.txt')
df = queries.species('Sturnus vulgaris').run(db_conn)
```

0 comments on commit d0bb6ee

Please sign in to comment.