<!-- markdownlint-disable-file MD033-->
<!-- PROJECT LOGO -->
<br/>
<p align="center">
<a href="https://github.com/wasi-master/sponsorblock.py">
<img src="https://raw.githubusercontent.com/wasi-master/sponsorblock.py/main/images/logo.png" alt="Logo" width="200" height="200">
</a>
<h2 align="center">sponsorblock.py</h2>
<p align="center">
A wrapper for the SponsorBlock API
<br />
<a href="https://sponsorblockpy.readthedocs.io/en/latest/"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/wasi-master/sponsorblock.py/blob/main/demo.md">View Demo</a>
·
<a href="https://github.com/wasi-master/sponsorblock.py/issues">Report Bug</a>
·
<a href="https://github.com/wasi-master/sponsorblock.py/issues">Request Feature</a>
</p>
</p>
<p align="center">
<a href="https://github.com/wasi-master/sponsorblock.py/graphs/contributors"><img src="https://img.shields.io/github/contributors/wasi-master/sponsorblock.py.svg?style=flat" alt="Contributors"></a>
<a href="https://github.com/wasi-master/sponsorblock.py/network/members"><img src="https://img.shields.io/github/forks/wasi-master/sponsorblock.py.svg?style=flat" alt="Forks"></a>
<a href="https://github.com/wasi-master/sponsorblock.py/stargazers"><img src="https://img.shields.io/github/stars/wasi-master/sponsorblock.py.svg?style=flat" alt="Stargazers"></a>
<a href="https://github.com/wasi-master/sponsorblock.py/issues"><img src="https://img.shields.io/github/issues/wasi-master/sponsorblock.py.svg?style=flat" alt="Issues"></a>
<a href="https://github.com/wasi-master/sponsorblock.py"><img src="https://img.shields.io/github/languages/code-size/wasi-master/sponsorblock.py.svg?style=flat" alt="Code Size"></a>
<a href="https://github.com/wasi-master/sponsorblock.py/blob/master/LICENSE"><img src="https://img.shields.io/github/license/wasi-master/sponsorblock.py.svg?style=flat" alt="MIT License"></a>
<a href="https://saythanks.io/to/wasi-master"><img src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg" alt="Say Thanke"></a>
<a href="https://pypistats.org/packages/sponsorblock.py"><img src="https://img.shields.io/pypi/dm/sponsorblock.py.svg?style=flat" alt="Downloads last Month"></a>
<a href="https://pypistats.org/packages/sponsorblock.py"><img src="https://img.shields.io/pypi/dw/sponsorblock.py.svg?style=flat" alt="Downloads last Week"></a>
<a href="https://pypistats.org/packages/sponsorblock.py"><img src="https://img.shields.io/pypi/dd/sponsorblock.py.svg?style=flat" alt="Downloads last Day"></a>
<a href="https://pypi.org/project/sponsorblock.py/#history"><img src="https://img.shields.io/pypi/v/sponsorblock.py.svg" alt="Version"></a>
<a href='https://sponsorblockpy.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/sponsorblockpy/badge/?version=latest' alt='Documentation Status' /></a>
<a href="https://github.com/wasi-master/sponsorblock.py/actions/workflows/python-app.yml"><img src="https://img.shields.io/github/workflow/status/wasi-master/sponsorblock.py/Python%20application.svg?label=tests" alt="Tests"></a>
<a href="https://github.com/wasi-master/sponsorblock.py/actions/workflows/python-publish.yml"><img src="https://img.shields.io/github/workflow/status/wasi-master/sponsorblock.py/Upload%20Python%20Package.svg?label=build" alt="Build"></a>
<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black"></a>
</p>
<!-- TABLE OF CONTENTS -->
<details open="open">
<summary><h2 style="display: inline-block">Table of Contents</h2></summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgements">Acknowledgements</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
## About The Project
sponsorblock.py is a wrapper for the [SponsorBlock](https://sponsor.ajay.app) [API](https://wiki.sponsor.ajay.app/index.php/API_Docs)
### Built With
* [python](https://www.python.org)
<!-- GETTING STARTED -->
## Getting Started
To install sponsorblock.py:
### Prerequisites
You'll need to have [python](https://www.python.org) installed in order to use the extension
### Installation
* Installing via pip
1. Directly installing via pip (Recommended)
```sh
pip install sponsorblock.py
```
2. Installing using pip and git
```sh
pip install git+https://github.com/wasi-master/sponsorblock.py.git
```
* Cloning then installing
1. Clone the repo
```sh
git clone https://github.com/wasi-master/sponsorblock.py.git
```
2. Changing the current working directory to the directory of the project
```sh
cd sponsorblock.py
```
3. Install using pip
```sh
pip install .
```
<!-- USAGE EXAMPLES -->
## Usage
See the [documentation](https://sponsorblockpy.readthedocs.io/en/latest/)
There is also a cli that you can use to get segments from the command line (beta).\
To use that run:
```sh
sponsorblock video_id
```
and pass your desired video_id
## Roadmap
See the [todo list](https://github.com/wasi-master/sponsorblock.py/blob/main/TODO.md) for a list of features yet to be added and features already added.
Also see the [open issues](https://github.com/wasi-master/sponsorblock.py/issues) for issues.
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<!-- LICENSE -->
## License
Distributed under the MIT License. See [`LICENSE`](LICENSE) for more information.
<!-- CONTACT -->
## Contact
Project Link: [https://github.com/wasi-master/sponsorblock.py](https://github.com/wasi-master/sponsorblock.py)
Discord: [Wasi Master#6969](https://discord.com/users/723234115746398219)
Email: [arianmollik323@gmail.com](mailto:arianmollik323@gmail.com)
Raw data
{
"_id": null,
"home_page": "https://wasi-master.github.io/sponsorblock.py/",
"name": "sponsorblock.py",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "sponsorblock.py,documentation,sponsorblock,python,api,wrapper,sponsor,block,youtube,youtube-dl,youtube-dlp",
"author": "Wasi Master",
"author_email": "arianmollik323@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e5/9b/ffcce979bdecf63a40e63d6163951bc31cb4e5ab76d9626d0e058edfb0e6/sponsorblock.py-0.2.3.tar.gz",
"platform": null,
"description": "<!-- markdownlint-disable-file MD033-->\r\n\r\n<!-- PROJECT LOGO -->\r\n<br/>\r\n<p align=\"center\">\r\n <a href=\"https://github.com/wasi-master/sponsorblock.py\">\r\n <img src=\"https://raw.githubusercontent.com/wasi-master/sponsorblock.py/main/images/logo.png\" alt=\"Logo\" width=\"200\" height=\"200\">\r\n </a>\r\n\r\n <h2 align=\"center\">sponsorblock.py</h2>\r\n\r\n <p align=\"center\">\r\n A wrapper for the SponsorBlock API\r\n <br />\r\n <a href=\"https://sponsorblockpy.readthedocs.io/en/latest/\"><strong>Explore the docs \u00bb</strong></a>\r\n <br />\r\n <br />\r\n <a href=\"https://github.com/wasi-master/sponsorblock.py/blob/main/demo.md\">View Demo</a>\r\n \u00b7\r\n <a href=\"https://github.com/wasi-master/sponsorblock.py/issues\">Report Bug</a>\r\n \u00b7\r\n <a href=\"https://github.com/wasi-master/sponsorblock.py/issues\">Request Feature</a>\r\n </p>\r\n</p>\r\n\r\n<p align=\"center\">\r\n <a href=\"https://github.com/wasi-master/sponsorblock.py/graphs/contributors\"><img src=\"https://img.shields.io/github/contributors/wasi-master/sponsorblock.py.svg?style=flat\" alt=\"Contributors\"></a>\r\n <a href=\"https://github.com/wasi-master/sponsorblock.py/network/members\"><img src=\"https://img.shields.io/github/forks/wasi-master/sponsorblock.py.svg?style=flat\" alt=\"Forks\"></a>\r\n <a href=\"https://github.com/wasi-master/sponsorblock.py/stargazers\"><img src=\"https://img.shields.io/github/stars/wasi-master/sponsorblock.py.svg?style=flat\" alt=\"Stargazers\"></a>\r\n <a href=\"https://github.com/wasi-master/sponsorblock.py/issues\"><img src=\"https://img.shields.io/github/issues/wasi-master/sponsorblock.py.svg?style=flat\" alt=\"Issues\"></a>\r\n <a href=\"https://github.com/wasi-master/sponsorblock.py\"><img src=\"https://img.shields.io/github/languages/code-size/wasi-master/sponsorblock.py.svg?style=flat\" alt=\"Code Size\"></a>\r\n <a href=\"https://github.com/wasi-master/sponsorblock.py/blob/master/LICENSE\"><img src=\"https://img.shields.io/github/license/wasi-master/sponsorblock.py.svg?style=flat\" alt=\"MIT License\"></a>\r\n <a href=\"https://saythanks.io/to/wasi-master\"><img src=\"https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg\" alt=\"Say Thanke\"></a>\r\n <a href=\"https://pypistats.org/packages/sponsorblock.py\"><img src=\"https://img.shields.io/pypi/dm/sponsorblock.py.svg?style=flat\" alt=\"Downloads last Month\"></a>\r\n <a href=\"https://pypistats.org/packages/sponsorblock.py\"><img src=\"https://img.shields.io/pypi/dw/sponsorblock.py.svg?style=flat\" alt=\"Downloads last Week\"></a>\r\n <a href=\"https://pypistats.org/packages/sponsorblock.py\"><img src=\"https://img.shields.io/pypi/dd/sponsorblock.py.svg?style=flat\" alt=\"Downloads last Day\"></a>\r\n <a href=\"https://pypi.org/project/sponsorblock.py/#history\"><img src=\"https://img.shields.io/pypi/v/sponsorblock.py.svg\" alt=\"Version\"></a>\r\n <a href='https://sponsorblockpy.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/sponsorblockpy/badge/?version=latest' alt='Documentation Status' /></a>\r\n <a href=\"https://github.com/wasi-master/sponsorblock.py/actions/workflows/python-app.yml\"><img src=\"https://img.shields.io/github/workflow/status/wasi-master/sponsorblock.py/Python%20application.svg?label=tests\" alt=\"Tests\"></a>\r\n <a href=\"https://github.com/wasi-master/sponsorblock.py/actions/workflows/python-publish.yml\"><img src=\"https://img.shields.io/github/workflow/status/wasi-master/sponsorblock.py/Upload%20Python%20Package.svg?label=build\" alt=\"Build\"></a>\r\n <a href=\"https://github.com/psf/black\"><img src=\"https://img.shields.io/badge/code%20style-black-000000.svg\" alt=\"Code style: black\"></a>\r\n</p>\r\n\r\n<!-- TABLE OF CONTENTS -->\r\n<details open=\"open\">\r\n <summary><h2 style=\"display: inline-block\">Table of Contents</h2></summary>\r\n <ol>\r\n <li>\r\n <a href=\"#about-the-project\">About The Project</a>\r\n <ul>\r\n <li><a href=\"#built-with\">Built With</a></li>\r\n </ul>\r\n </li>\r\n <li>\r\n <a href=\"#getting-started\">Getting Started</a>\r\n <ul>\r\n <li><a href=\"#prerequisites\">Prerequisites</a></li>\r\n <li><a href=\"#installation\">Installation</a></li>\r\n </ul>\r\n </li>\r\n <li><a href=\"#usage\">Usage</a></li>\r\n <li><a href=\"#roadmap\">Roadmap</a></li>\r\n <li><a href=\"#contributing\">Contributing</a></li>\r\n <li><a href=\"#license\">License</a></li>\r\n <li><a href=\"#contact\">Contact</a></li>\r\n <li><a href=\"#acknowledgements\">Acknowledgements</a></li>\r\n </ol>\r\n</details>\r\n\r\n<!-- ABOUT THE PROJECT -->\r\n## About The Project\r\n\r\nsponsorblock.py is a wrapper for the [SponsorBlock](https://sponsor.ajay.app) [API](https://wiki.sponsor.ajay.app/index.php/API_Docs)\r\n\r\n### Built With\r\n\r\n* [python](https://www.python.org)\r\n\r\n<!-- GETTING STARTED -->\r\n## Getting Started\r\n\r\nTo install sponsorblock.py:\r\n\r\n### Prerequisites\r\n\r\nYou'll need to have [python](https://www.python.org) installed in order to use the extension\r\n\r\n### Installation\r\n\r\n* Installing via pip\r\n 1. Directly installing via pip (Recommended)\r\n\r\n ```sh\r\n pip install sponsorblock.py\r\n ```\r\n\r\n 2. Installing using pip and git\r\n\r\n ```sh\r\n pip install git+https://github.com/wasi-master/sponsorblock.py.git\r\n ```\r\n\r\n* Cloning then installing\r\n 1. Clone the repo\r\n\r\n ```sh\r\n git clone https://github.com/wasi-master/sponsorblock.py.git\r\n ```\r\n\r\n 2. Changing the current working directory to the directory of the project\r\n\r\n ```sh\r\n cd sponsorblock.py\r\n ```\r\n\r\n 3. Install using pip\r\n\r\n ```sh\r\n pip install .\r\n ```\r\n\r\n<!-- USAGE EXAMPLES -->\r\n## Usage\r\n\r\nSee the [documentation](https://sponsorblockpy.readthedocs.io/en/latest/)\r\n\r\nThere is also a cli that you can use to get segments from the command line (beta).\\\r\nTo use that run:\r\n\r\n```sh\r\nsponsorblock video_id\r\n```\r\n\r\nand pass your desired video_id\r\n\r\n## Roadmap\r\n\r\nSee the [todo list](https://github.com/wasi-master/sponsorblock.py/blob/main/TODO.md) for a list of features yet to be added and features already added.\r\nAlso see the [open issues](https://github.com/wasi-master/sponsorblock.py/issues) for issues.\r\n\r\n<!-- CONTRIBUTING -->\r\n## Contributing\r\n\r\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\r\n\r\n1. Fork the Project\r\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\r\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\r\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\r\n5. Open a Pull Request\r\n\r\n<!-- LICENSE -->\r\n## License\r\n\r\nDistributed under the MIT License. See [`LICENSE`](LICENSE) for more information.\r\n\r\n<!-- CONTACT -->\r\n## Contact\r\n\r\nProject Link: [https://github.com/wasi-master/sponsorblock.py](https://github.com/wasi-master/sponsorblock.py)\r\n\r\nDiscord: [Wasi Master#6969](https://discord.com/users/723234115746398219)\r\n\r\nEmail: [arianmollik323@gmail.com](mailto:arianmollik323@gmail.com)\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An unofficial wrapper for the SponsorBlock API",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://wasi-master.github.io/sponsorblock.py/"
},
"split_keywords": [
"sponsorblock.py",
"documentation",
"sponsorblock",
"python",
"api",
"wrapper",
"sponsor",
"block",
"youtube",
"youtube-dl",
"youtube-dlp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a0f3bc2681346365c34c5c07003187739333b3d4eb26c7609b722679e49b423",
"md5": "372634f75f56e47960789bdb43d83647",
"sha256": "999617f38e10325207ab3902232f630c87235bd85cd76be7cf284b950a561eba"
},
"downloads": -1,
"filename": "sponsorblock.py-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "372634f75f56e47960789bdb43d83647",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 18092,
"upload_time": "2023-06-16T08:37:57",
"upload_time_iso_8601": "2023-06-16T08:37:57.374000Z",
"url": "https://files.pythonhosted.org/packages/4a/0f/3bc2681346365c34c5c07003187739333b3d4eb26c7609b722679e49b423/sponsorblock.py-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e59bffcce979bdecf63a40e63d6163951bc31cb4e5ab76d9626d0e058edfb0e6",
"md5": "052e0144f86e21f0a32d3de4e854913b",
"sha256": "050129046749d1c53458ffdefc04e04927464bd94d1696cdefdfef65db4d7a57"
},
"downloads": -1,
"filename": "sponsorblock.py-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "052e0144f86e21f0a32d3de4e854913b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 18447,
"upload_time": "2023-06-16T08:37:58",
"upload_time_iso_8601": "2023-06-16T08:37:58.959345Z",
"url": "https://files.pythonhosted.org/packages/e5/9b/ffcce979bdecf63a40e63d6163951bc31cb4e5ab76d9626d0e058edfb0e6/sponsorblock.py-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-16 08:37:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sponsorblock.py"
}
JSON