# tap-sleeper 
[](https://hub.meltano.com/taps/sleeper)
[](https://pypi.org/project/tap-sleeper/)
[](https://pypi.org/project/tap-sleeper/)
[](https://github.com/collinprather/tap-sleeper/actions/workflows/super-linter.yml)
[](https://github.com/collinprather/tap-sleeper/actions/workflows/test-pypi.yml)
[](https://github.com/collinprather/tap-sleeper/actions/workflows/test-tap.yml)
[](https://github.com/collinprather/tap-sleeper/actions/workflows/codeql-analysis.yml)
`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 or status of any NFL players, or granular information about your fantasy football league.
## Installation
```bash
pipx install tap-sleeper
```
## Configuration
### Accepted Config Options
| **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:
```bash
tap-sleeper --about
```
## Usage
You can easily run `tap-sleeper` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-sleeper --version
tap-sleeper --help
tap-sleeper --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `tap_sleeper/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-sleeper` CLI interface directly using `poetry run`:
```bash
poetry run tap-sleeper --help
```
### Testing with [Meltano](https://www.meltano.com)
_**Note:** This tap will work in any Singer environment and does not require Meltano.
Examples here are for convenience and to streamline end-to-end orchestration scenarios._
Your project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any _"TODO"_ items listed in
the file.
Next, install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-sleeper
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-sleeper --version
# OR run a test `elt` pipeline:
meltano elt tap-sleeper target-jsonl
```
### SDK Dev Guide
See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.
Raw data
{
"_id": null,
"home_page": "https://github.com/collinprather/tap-sleeper",
"name": "tap-sleeper",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "ELT,Sleeper,Football",
"author": "Collin Prather",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/ec/2b/2f1aaa75ec19decb38f8632883cb3b7fd5fdf8f35d34be961ef4cc5c8a82/tap_sleeper-0.5.3.tar.gz",
"platform": null,
"description": "# tap-sleeper \n\n\n[](https://hub.meltano.com/taps/sleeper)\n[](https://pypi.org/project/tap-sleeper/)\n[](https://pypi.org/project/tap-sleeper/)\n[](https://github.com/collinprather/tap-sleeper/actions/workflows/super-linter.yml)\n[](https://github.com/collinprather/tap-sleeper/actions/workflows/test-pypi.yml)\n[](https://github.com/collinprather/tap-sleeper/actions/workflows/test-tap.yml)\n[](https://github.com/collinprather/tap-sleeper/actions/workflows/codeql-analysis.yml)\n\n`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 or status of any NFL players, or granular information about your fantasy football league.\n\n\n## Installation\n\n```bash\npipx install tap-sleeper\n```\n\n## Configuration\n\n### Accepted Config Options\n\n| **Property** | **Type** | **Required** | **Description** |\n|---------------------------------|----------|--------------|--------------------------------------------------------------------------------|\n| sport | string | True | Professional sport league, ie nfl, nba, etc |\n| league_id | string | False | Unique identifier for the sleeper league |\n| trending_players_lookback_hours | integer | False | Total hours to lookback when requesting the current trending players |\n| trending_players_limit | integer | False | Total number of players to return when requesting the current trending players |\n\nA full list of supported settings and capabilities for this\ntap is available by running:\n\n```bash\ntap-sleeper --about\n```\n\n## Usage\n\nYou can easily run `tap-sleeper` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-sleeper --version\ntap-sleeper --help\ntap-sleeper --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\n\n### Initialize your Development Environment\n\n```bash\npipx install poetry\npoetry install\n```\n\n### Create and Run Tests\n\nCreate tests within the `tap_sleeper/tests` subfolder and\n then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-sleeper` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-sleeper --help\n```\n\n### Testing with [Meltano](https://www.meltano.com)\n\n_**Note:** This tap will work in any Singer environment and does not require Meltano.\nExamples here are for convenience and to streamline end-to-end orchestration scenarios._\n\nYour project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any _\"TODO\"_ items listed in\nthe file.\n\nNext, install Meltano (if you haven't already) and any needed plugins:\n\n```bash\n# Install meltano\npipx install meltano\n# Initialize meltano within this directory\ncd tap-sleeper\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-sleeper --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-sleeper target-jsonl\n```\n\n### SDK Dev Guide\n\nSee the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to\ndevelop your own taps and targets.\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "`tap-sleeper` is a Singer tap for Sleeper, built with the Meltano SDK for Singer Taps.",
"version": "0.5.3",
"project_urls": {
"Homepage": "https://github.com/collinprather/tap-sleeper",
"Repository": "https://github.com/collinprather/tap-sleeper"
},
"split_keywords": [
"elt",
"sleeper",
"football"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26ceb324f2e2e036e8c551e06d8638f165027d4e2656303c9e5347b6c74007a3",
"md5": "ed7e67fd693125d70666bef4abd942fc",
"sha256": "545d82bb6b3178f463c8abddff85734ae548d78a4d14d8d4f4dd334087154f27"
},
"downloads": -1,
"filename": "tap_sleeper-0.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ed7e67fd693125d70666bef4abd942fc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 9385,
"upload_time": "2024-03-05T18:27:43",
"upload_time_iso_8601": "2024-03-05T18:27:43.445241Z",
"url": "https://files.pythonhosted.org/packages/26/ce/b324f2e2e036e8c551e06d8638f165027d4e2656303c9e5347b6c74007a3/tap_sleeper-0.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec2b2f1aaa75ec19decb38f8632883cb3b7fd5fdf8f35d34be961ef4cc5c8a82",
"md5": "966732ae6a81c923a9af7955cb517e9c",
"sha256": "f5ecc35af656458e76f0e97348a02b86de190b645f4e202591c88b9e47629677"
},
"downloads": -1,
"filename": "tap_sleeper-0.5.3.tar.gz",
"has_sig": false,
"md5_digest": "966732ae6a81c923a9af7955cb517e9c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 8345,
"upload_time": "2024-03-05T18:27:44",
"upload_time_iso_8601": "2024-03-05T18:27:44.451855Z",
"url": "https://files.pythonhosted.org/packages/ec/2b/2f1aaa75ec19decb38f8632883cb3b7fd5fdf8f35d34be961ef4cc5c8a82/tap_sleeper-0.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 18:27:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "collinprather",
"github_project": "tap-sleeper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tap-sleeper"
}
JSON
