Skip to content

Commit

Permalink
README & docs improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
Graeme22 committed Jan 14, 2025
1 parent eca1890 commit 0b3cdf8
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ Since Tastytrade certification sessions are severely limited in capabilities, th
## Steps to follow to contribute

1. Fork the repository to your personal Github account and make your proposed changes.
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.
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.
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.
4. Run `make install` to create the virtual environment, then `make lint` and `make test` to run the tests locally.
4. Run `make install` to create the virtual environment, `make lint` to format your code, and `make test` to run the tests locally.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@ A simple, reverse-engineered SDK for Tastytrade built on their (now mostly publi
- Comprehensive documentation
- Utility functions for timezone calculations, futures monthly expiration dates, and more

> [!NOTE]
> [!TIP]
> 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.
> [!NOTE]
> 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!
## Installation

```console
Expand Down
7 changes: 7 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
:target: https://pepy.tech/project/tastytrade
:alt: PyPI Downloads

.. image:: https://img.shields.io/github/v/release/tastyware/tastytrade?label=release%20notes
:target: https://github.com/tastyware/tastytrade/releases
:alt: Release

Tastytrade Python SDK
=====================

Expand All @@ -18,6 +22,9 @@ A simple, reverse-engineered, sync/async SDK for Tastytrade built on their (now
.. tip::
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.

.. tip::
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!

.. toctree::
:maxdepth: 2
:caption: Documentation:
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Installation
Via pypi
--------

The easiest way to install tastytrade is using pip:
The easiest way to install the SDK is using pip:

::

Expand Down

0 comments on commit 0b3cdf8

Please sign in to comment.