Skip to content

Commit 0b3cdf8

Browse files
committed
README & docs improvements
1 parent eca1890 commit 0b3cdf8

File tree

4 files changed

+14
-4
lines changed

4 files changed

+14
-4
lines changed

Diff for: .github/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ Since Tastytrade certification sessions are severely limited in capabilities, th
55
## Steps to follow to contribute
66

77
1. Fork the repository to your personal Github account and make your proposed changes.
8-
2. Export your username, password, and account number to the following environment variables: `TT_USERNAME`, `TT_PASSWORD`, and `TT_ACCOUNT`. The account should be a margin account.
8+
2. Export your username, password, and account number to the following Github Actions repository secrets: `TT_USERNAME`, `TT_PASSWORD`, and `TT_ACCOUNT`. The account should be a margin account.
99
3. Make sure you have at least one share of long $F in your account, which will be used to place the OCO complex order (nothing will fill), as well as at least $2 of buying power.
10-
4. Run `make install` to create the virtual environment, then `make lint` and `make test` to run the tests locally.
10+
4. Run `make install` to create the virtual environment, `make lint` to format your code, and `make test` to run the tests locally.

Diff for: README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,12 @@ A simple, reverse-engineered SDK for Tastytrade built on their (now mostly publi
1717
- Comprehensive documentation
1818
- Utility functions for timezone calculations, futures monthly expiration dates, and more
1919

20-
> [!NOTE]
20+
> [!TIP]
2121
> Want to see the SDK in action? Check out [tastytrade-cli](https://github.com/tastyware/tastytrade-cli), a CLI for Tastytrade that showcases many of the SDK's features.
2222
23+
> [!NOTE]
24+
> Do you use TradeStation? We're building a [brand-new SDK](https://github.com/tastyware/tradestation) for TS users, with many of the same features!
25+
2326
## Installation
2427

2528
```console

Diff for: docs/index.rst

+7
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@
1010
:target: https://pepy.tech/project/tastytrade
1111
:alt: PyPI Downloads
1212

13+
.. image:: https://img.shields.io/github/v/release/tastyware/tastytrade?label=release%20notes
14+
:target: https://github.com/tastyware/tastytrade/releases
15+
:alt: Release
16+
1317
Tastytrade Python SDK
1418
=====================
1519

@@ -18,6 +22,9 @@ A simple, reverse-engineered, sync/async SDK for Tastytrade built on their (now
1822
.. tip::
1923
Want to see the SDK in action? Check out `tastytrade-cli <https://github.com/tastyware/tastytrade-cli>`_, a CLI for Tastytrade that showcases many of the SDK's features.
2024

25+
.. tip::
26+
Do you use TradeStation? We're building a `brand-new SDK <https://github.com/tastyware/tradestation>`_ for TS users, with many of the same features!
27+
2128
.. toctree::
2229
:maxdepth: 2
2330
:caption: Documentation:

Diff for: docs/installation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Installation
44
Via pypi
55
--------
66

7-
The easiest way to install tastytrade is using pip:
7+
The easiest way to install the SDK is using pip:
88

99
::
1010

0 commit comments

Comments
 (0)