fix: Update documentation (#60)

* Update README.md * fix: Clean up dependencies and release * Semantic Release * 0.0.1 Automatically generated by python-semantic-release * fix: Semantic Release * 0.0.2 Automatically generated by python-semantic-release * 0.0.1 Automatically generated by python-semantic-release * major: Semantic Release * semantice-release-1 (#58) BREAKING CHANGE: semantic release * major: Semanticc Release BREAKING CHANGE: Semantic * 1.0.0 Automatically generated by python-semantic-release * major: Semanticc Release BREAKING CHANGE: Semantic * 2.0.0 Automatically generated by python-semantic-release * major: Semanticc Release BREAKING CHANGE: Semantic Release * 3.0.0 Automatically generated by python-semantic-release * Update README.md --------- Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: semantic-release <semantic-release>
bcanfield · Oct 18, 2023 · 7eb8e9f · 7eb8e9f
1 parent 277171b
commit 7eb8e9f
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 126 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -25,40 +25,40 @@
 
 * Fanduel Automation Crackdown Fix (#38)
 
-* Fix Fanduel authorization
-
-* Update README.md
-
+* Fix Fanduel authorization
+
+* Update README.md
+
 * Increment version ([`7fbfb57`](https://github.com/bcanfield/southpaw/commit/7fbfb57a4be1f04c5852312f4ddfc7874eeefdae))
 
 * Update README.md ([`2ec2356`](https://github.com/bcanfield/southpaw/commit/2ec2356bbe25be82434e058e76612451888e012b))
 
 * Automate entries (#18)
 
-* Update README.md
-
-* Add update entries function
-
-* Update unit tests
-
-* Update readme
-
-* Bump version
-
+* Update README.md
+
+* Add update entries function
+
+* Update unit tests
+
+* Update readme
+
+* Bump version
+
 * Fix deps ([`e362d42`](https://github.com/bcanfield/southpaw/commit/e362d42cfa4d83b971127f96b0f624b2cc1cdbf2))
 
 * New develop (#16)
 
-* Enhance fanduel
-
-* Add helper functions
-
-* Update README
-
-* Remove unnecessary json file
-
-* Update Fanduel
-
+* Enhance fanduel
+
+* Add helper functions
+
+* Update README
+
+* Remove unnecessary json file
+
+* Update Fanduel
+
 * Update version ([`498aae2`](https://github.com/bcanfield/southpaw/commit/498aae2931190ac971a41f49d02783d0a1f24cbb))
 
 * Fix build ([`292807b`](https://github.com/bcanfield/southpaw/commit/292807b4ebb49f20e66a1b65d7fe741ed1839c09))
@@ -77,10 +77,10 @@
 
 * Fix and update Fanduel api (#8)
 
-* Improve user authentication process
-
-* Improve fanduel api
-
+* Improve user authentication process
+
+* Improve fanduel api
+
 * Remove unused functionality ([`2f554df`](https://github.com/bcanfield/southpaw/commit/2f554df928caf114cb3fa3c7e6db58f1675fe2a3))
 
 * Attempt to fix linear generation ([`e59e60f`](https://github.com/bcanfield/southpaw/commit/e59e60f4741e584451cc280a5fe160591e6ff2b3))

diff --git a/README.md b/README.md
@@ -1,121 +1,49 @@
-
-
-
-
-
-
-
 ![southpawgithub](https://user-images.githubusercontent.com/12603953/126020923-ea260184-ac3c-4960-bec3-0e68e3b89136.png)
 
-
-
-
-
-
-
-
-
-
-
-[![PyPI pyversions](https://img.shields.io/pypi/v/southpaw)](https://pypi.python.org/pypi/southpaw/) [![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-360/)
-
-
-
-
-
-
+[![Downloads](https://static.pepy.tech/badge/southpaw)](https://pypi.org/project/southpaw/)
 
 **Southpaw** is a python package that provides access to the Fanduel API.
 
-
-
-
-
 Optimize your DFS experience by programmatically retrieving and updating your lineups, analyzing your data, and more.
 
+[API Documentation](https://bcanfield.github.io/southpaw/)
 
-
-
-
-
-
-[Full Documentation](https://bcanfield.github.io/southpaw/)
-
-
-
-
-
-
-
-## Installation
-
-
-
-
-
-
-
-Install via [PyPi](https://pypi.org/project/southpaw/)
-
-
-
-
-
+# Installation
 ```
-
-  
-
 python -m pip install southpaw
-
-  
-
 ```
 
-  
+# Setup
 
 
+**UPDATE (October 2023):**
 
-  
+**Fanduel has cracked down on automated methods of logging in and now requires two-factor auth - so this process now takes an extra initial step now to retrieve the auth headers.**
 
-## Initial Setup
-
-
-**UPDATE (2023): Fanduel has cracked down on automated methods of logging in - so this process takes an extra initial step now to retrieve the necessary headers.**
-
-
-Retrieve your basic auth token by logging into fanduel.com and copying the authorization header and x-auth-header from the dev console. (Green boxes)
+## How to retrieve your auth headers
+1. Go to [Fanduel DFS](https://www.fanduel.com/contests) and log in.
+2. Open up your browser inspector, toggle the Network tab, and refresh the page to view the requests.
+4. You need to find one of the requests that is being sent to **https://api.fanduel.com**. Some examples are **fixture-lists?** and **current?**
+5. In the **Response Headers** section, copy out the **Authorization** header and **X-Auth-Token**. Reference my screenshot below.
 
+*Note: The x-auth-token expires. So you will have to repeat the method above when it does*
 
-<img width="798" alt="Screen Shot 2022-06-16 at 2 58 17 PM" src="https://user-images.githubusercontent.com/12603953/174152698-d48f4b07-5b81-48d2-a8ab-daceb59ecb07.png"  width="600" height="450">
+<img width="736" alt="Screenshot 2023-10-17 at 10 43 51 PM" src="https://github.com/bcanfield/southpaw/assets/12603953/b3a5f76b-6a87-4094-8fe6-e956072bfd2a">
 
-
-<br></br>
-Initialize your Fanduel object using your Fanduel email, password, and auth tokens. Initializing the Fanduel object will send off a test request to ensure that you can succesfully authenticate.  
+## Start having fun 
+You first must initialize your Fanduel object using your email, password, and auth tokens. You will see a success message if you succesfully authenticate.
 
 ```
-
 import southpaw
 
-  
 basic_auth_token = 'Basic GBGskzdmGLKOP5EwMDNkNGUaLkFdM2VjKJHDNmY1Mjc6'
-
 x_auth_token = 'eyasdffdsaasjhkdfbfkhdsbakjbasdkjfbnfkjdsaetgdffgdfdgs'
-  
 fanduel_email = 'fakeFanduelEmail@gmail.com'
-
 fanduel_password = 'fakeFanduelPassword'
 
-fd = southpaw.Fanduel(fanduel_email, fanduel_password, basic_auth_token, x_auth_token)
-
+fd = southpaw.Fanduel(fanduel_email, fanduel_password, basic_auth_token, x_auth_token
 ```
-
-
-
-
-
-Once you call this function, you now have access to all of the data that Fanduel offers by using a rich set of helper functions that Southpaw provides.
-
-
+You now have access to all of the data that Fanduel offers by using a rich set of helper functions that Southpaw provides.
 
 ## Examples
 
@@ -131,7 +59,6 @@ Get a list of all currently entered contests and all relevant info.
 
 *FYI: If you are not entered into any Fanduel contests you will not get any back*
 ```
-
 # Get a list of all currently entered contests
 contests = fd.easy_get_contests()
 
@@ -158,19 +85,11 @@ if len(contests) > 0:
 # Just blindly taking first 5 players as an example
 players_to_use = available_players[:5]
 update_entry_input = [UpdateEntryInput({'id': entry["id"], 'lineup': players_to_use})]
-
 ```
-
-
-
 ## Disclaimer
 
-
-
 This project is for educational use only.
 
-
-
 Accumulating Fanduel points or prizes through unauthorized methods such as unauthorized scripts or other automated means is against the Fanduel terms and may result in account disqualification.
 
 The contributors of Southpaw shall not be held responsible for any actions taken using this tool.