updating readme and ConfigIncompleteError

Author: collinprather

README.md

@@ -6,15 +6,11 @@
 [![Test Tap](https://github.com/collinprather/tap-sleeper/actions/workflows/test-tap.yml/badge.svg)](https://github.com/collinprather/tap-sleeper/actions/workflows/test-tap.yml)
 [![CodeQL](https://github.com/collinprather/tap-sleeper/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/collinprather/tap-sleeper/actions/workflows/codeql-analysis.yml)
 
-`tap-sleeper` is a Singer tap for the [Sleeper](https://sleeper.app/) [api](https://docs.sleeper.app/).
-
-Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
+`tap-sleeper` is a [Singer](https://hub.meltano.com/singer/spec) tap for the [Sleeper](https://sleeper.app/) [api](https://docs.sleeper.app/), built with the [Meltano Tap SDK](https://sdk.meltano.com), which makes it easy to pull the latest news about any NFL players, trending players, or granular information about your fantasy football league.
 
 
 ## Installation
 
-- [ ] `Developer TODO:` Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.
-
 ```bash
 pipx install tap-sleeper
 ```
@@ -23,7 +19,12 @@ pipx install tap-sleeper
 
 ### Accepted Config Options
 
-- [ ] `Developer TODO:` Provide a list of config options accepted by the tap.
+| **Property**                    | **Type** | **Required** | **Description**                                                                |
+|---------------------------------|----------|--------------|--------------------------------------------------------------------------------|
+| sport                           | string   | True         | Professional sport league, ie nfl, nba, etc"                                   |
+| league_id                       | string   | False        | Unique identifier for the sleeper league                                       |
+| trending_players_lookback_hours | integer  | False        | Total hours to lookback when requesting the current trending players           |
+| trending_players_limit          | integer  | False        | Total number of players to return when requesting the current trending players |
 
 A full list of supported settings and capabilities for this
 tap is available by running:
@@ -32,10 +33,6 @@ tap is available by running:
 tap-sleeper --about
 ```
 
-### Source Authentication and Authorization
-
-- [ ] `Developer TODO:` If your tap requires special access on the source system, or any special authentication requirements, provide those here.
-
 ## Usage
 
 You can easily run `tap-sleeper` by itself or in a pipeline using [Meltano](https://meltano.com/).
@@ -50,8 +47,6 @@ tap-sleeper --config CONFIG --discover > ./catalog.json
 
 ## Developer Resources
 
-- [ ] `Developer TODO:` As a first step, scan the entire project for the text "`TODO:`" and complete any recommended steps, deleting the "TODO" references once completed.
-
 ### Initialize your Development Environment
 
 ```bash

tap_sleeper/streams.py

@@ -73,19 +73,15 @@ class LeagueStream(SleeperStream):
     name = "league"
     parent_stream_type = SportStateStream
 
-    def __init__(self, tap) -> None:
-        """Initialize the League stream and assert that config includes league_id."""
-        super().__init__(tap=tap, name=self.name, schema=self.schema)
+    def get_url(self, context: Optional[dict]) -> str:
         if "league_id" not in self.config.keys():
-            raise InvalidConfigError(
+            raise ConfigIncompleteForSelectedStreamsError(
                 """
                 Must supply league_id in config to pull league-related streams.
                 If you would not like to replicate league-related streams, remove
                 them from your catalog.json (or meltano.yml).
                 """
             )
-
-    def get_url(self, context: Optional[dict]) -> str:
         url = self.url_base + self.path.format(league_id=self.config["league_id"])
         return url
 
@@ -246,5 +242,5 @@ class LeagueDraftTradedPicksStream(LeagueDraftPicksStream):
     parent_stream_type = LeagueDraftsStream
 
 
-class InvalidConfigError(Exception):
+class ConfigIncompleteForSelectedStreamsError(Exception):
     pass