https://github.com/wasi-master/sponsorblock.py
An unofficial wrapper and a cli for the Sponsorblock API
https://github.com/wasi-master/sponsorblock.py
python sponsor sponsorblock youtube
Last synced: about 1 month ago
JSON representation
An unofficial wrapper and a cli for the Sponsorblock API
- Host: GitHub
- URL: https://github.com/wasi-master/sponsorblock.py
- Owner: wasi-master
- License: mit
- Created: 2021-08-23T18:23:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-16T08:35:17.000Z (over 2 years ago)
- Last Synced: 2025-08-19T11:38:40.212Z (about 2 months ago)
- Topics: python, sponsor, sponsorblock, youtube
- Language: Python
- Homepage: https://sponsorblockpy.readthedocs.io/en/latest/
- Size: 281 KB
- Stars: 25
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
sponsorblock.py
A wrapper for the SponsorBlock API
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## 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
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
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
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
Distributed under the MIT License. See [`LICENSE`](LICENSE) for more information.
## 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)