-
Notifications
You must be signed in to change notification settings - Fork 167
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #22 from alpacahq/update-read-me
Adds Alpha Stage Disclaimer to README
- Loading branch information
Showing
1 changed file
with
4 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,13 @@ | ||
# AlpacaPy | ||
|
||
|
||
### Dev setup | ||
|
||
This project is managed via poetry so setup should be just running `poetry install`. | ||
|
||
This repo is using [`pre-commit`](https://pre-commit.com/) to setup some checks to happen at commit time | ||
to keep the repo clean. To set these up after you've run `poetry install` just run `poetry run pre-commit | ||
install` to have pre-commit setup these hooks | ||
|
||
|
||
**Note: AlpacaPy is in the very early stages of alpha development and is not production ready. Currently AlpacaPy interfaces with only the Market Data API, however the other APIs are coming soon.** | ||
|