Skip to content
This repository has been archived by the owner on Mar 12, 2021. It is now read-only.

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RileyMShea committed Jan 23, 2021
1 parent 33b8f95 commit 10e5d34
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
<!-- ![upoly logo](upoly.png) -->

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Dependency Status](https://img.shields.io/librariesio/github/RileyMShea/upoly)]("")
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/RileyMShea/upoly/Tests)
![Lines of code](https://img.shields.io/tokei/lines/github/RileyMShea/upoly)
Expand All @@ -31,9 +32,10 @@ exceeds 50,000 trade bars.
## Installation

This library makes use of some high performance packages written in `C`/`Rust`
(uvloop, orjson) so it may require `python-dev` on Ubuntu or similar on
other OS's. It is compatible with Python 3.8.x and aims to be compatible with
all future CPython versions moving forward.
(uvloop, orjson) so it may require `sudo apt install python3-dev` on Ubuntu or similar on
other OS's. It is currently only compatible with Python 3.8.x but aims to be
compatible with 3.9 once it's dependendencies support 3.9
and all future CPython versions moving forward.

pip/poetry w/ venv

Expand Down Expand Up @@ -64,6 +66,16 @@ like so:
export POLYGON_KEY_ID=REPACEWITHPOLYGONORALPACAKEYHERE
```

or adding to your shell startup script, either `.zshrc` or `.bashrc` to have
it be globally available to all projects.

```bash
#/home/youruseraccount/.bashrc
...
export POLYGON_KEY_ID=REPACEWITHPOLYGONORALPACAKEYHERE
...
```

```python
# ./yourscript.py
import pytz
Expand All @@ -86,7 +98,7 @@ NY = pytz.timezone("America/New_York")
start = pd.Timestamp("2015-01-01", tz=NY)
end = pd.Timestamp("2020-01-01", tz=NY)

df = async_polygon_aggs("AAPL", "minute", 1, start, end)
df = async_polygon_aggs("AAPL", start, end)
```

## TODO
Expand Down

0 comments on commit 10e5d34

Please sign in to comment.