diff --git a/README.md b/README.md index 4d66cf9..82cd42b 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,36 @@ Minerva is the Roman equivalent of Athena, and Athena is AWS's database that stores results in S3. However, Minerva goes beyond that, and now eases all AWS access, and even offers its own cluster management with Dask. +## Athena In order to ease programmatic access to Athena and offer blocking access (so that your code waits for the result), I wrote `minerva` to make it seamless. The results are returned as pyarrow datasets (with parquet files as the underlying structure). +## Redshift + +## S3 + +## EC2 + +## Cluster + +## Dask + +## Helpers +I wrote a `Timing` module to help with timing various functions: + +``` +with Timing("my cool test"): + long_function() + +# Prints the following +# +# my cool test: +# => 32.45 +``` + # Basic Usage ``` import minerva as m