Update README for release

Author: DeflateAwning

README.md

@@ -1,2 +1,59 @@
 # polars_access_mdbtools
 A library for reading tables from an Access database into Polars dataframes, using mdbtools
+
+## What is this?
+
+A tiny, `subprocess`-based tool for reading a 
+[MS Access](https://products.office.com/en-us/access) 
+database (`.rdb`) as a [Python Polars Dataframe](https://docs.pola.rs).
+
+## Installation
+
+To read the database, this package thinly wraps 
+[MDBTools](https://github.com/mdbtools/mdbtools).
+
+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
+```
+
+If you are on `Windows`, it's a little tougher. Install `mdbtools` for [Windows](https://github.com/lsgunth/mdbtools-win). Manually add to PATH.
+1. Download the mdb-tools files from Windows link above. Visit the Releases section, then downloadi the part that says "Source Code (zip)".
+2. Extract that to somewhere like `C:/bin/mdbtools-win/mdbtools-win-1.0.0`.
+3. Follow these instructions to [add that folder to your environment path](https://linuxhint.com/add-directory-to-path-environment-variables-windows/) (Method 1, but use the path to the mdbtools executable files).
+4. Restart your computer or just close and re-open the program you're running it from. You can test that it works by opening a terminal and running `mdb-tables --help` and see that it doesn't fail.
+
+Finally, on all OS's:
+```sh
+$ pip install polars_access_mdbtools
+```
+
+## Example Usage
+
+```python
+import polars as pl
+import polars_access_mdbtools as pl_access
+
+file_path = 'path_to_file.mdb'
+pl_access.list_table_names(file_path)
+
+df = pl_access.read_table(file_path, table_name='your_table_name')
+
+```
+
+## Acknowledgements
+
+This code is based heavily on [jbn's `pandas_access` library](https://github.com/jbn/pandas_access).
+
+## Contributing
+
+Please Star this repo. 
+
+Please submit bug reports as GitHub Issues. Feel free to submit a PR to fix an issue!
+

pyproject.toml

@@ -13,7 +13,7 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-    "polars",
+    "polars >= 0.20",
 ]
 
 [project.urls]

src/polars_access_mdbtools/__init__.py

@@ -20,7 +20,7 @@ def list_table_names(rdb_file: Union[str, os.PathLike], encoding: str = 'utf-8')
     :param encoding: The content encoding of the output of the mdb-tables command.
     :return: A list of the tables in a given database.
     """
-    tables = subprocess.check_output(['mdb-tables', "--single-column", rdb_file]).decode(encoding)
+    tables = subprocess.check_output(['mdb-tables', "--single-column", str(rdb_file)]).decode(encoding)
     return tables.strip().split("\n")
 
 
@@ -92,7 +92,7 @@ def _read_table_mdb_schema(rdb_file: Union[str, os.PathLike], table_name: str, e
         '--no-indexes',
         '--no-relations',
         '--table', table_name,
-        rdb_file]
+        str(rdb_file)]
     cmd_output = subprocess.check_output(cmd)
     cmd_output = cmd_output.decode(encoding)
     lines = cmd_output.splitlines()
@@ -163,7 +163,7 @@ def read_table(rdb_file: Union[str, os.PathLike], table_name: str, data_encoding
         else:
             pl_schema_read[col_name] = col_type
 
-    cmd = ['mdb-export', '--bin=hex', '--date-format', '%Y-%m-%d', '--datetime-format', '%Y-%m-%dT%H:%M:%S', rdb_file, table_name]
+    cmd = ['mdb-export', '--bin=hex', '--date-format', '%Y-%m-%d', '--datetime-format', '%Y-%m-%dT%H:%M:%S', str(rdb_file), table_name]
 
     # Debug:
     # data_str = subprocess.check_output(cmd).decode(data_encoding)
@@ -175,7 +175,7 @@ def read_table(rdb_file: Union[str, os.PathLike], table_name: str, data_encoding
 
     with warnings.catch_warnings():
         warnings.filterwarnings("ignore", message="Polars found a filename.*")
-        
+
         df = pl.read_csv(
             proc.stdout,
             schema=pl_schema_read,