sponsorblock.py

A wrapper for the SponsorBlock API
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

sponsorblock.py is a wrapper for the SponsorBlock API

Built With

• python

Getting Started

To install sponsorblock.py:

Prerequisites

You'll need to have python installed in order to use the extension

Installation

• Installing via pip

  1. Directly installing via pip (Recommended)

     pip install sponsorblock.py

  2. Installing using pip and git

     pip install git+https://github.com/wasi-master/sponsorblock.py.git

• Cloning then installing

  1. Clone the repo

     git clone https://github.com/wasi-master/sponsorblock.py.git

  2. Changing the current working directory to the directory of the project

     cd sponsorblock.py

  3. Install using pip

     pip install .

Usage

See the documentation

There is also a cli that you can use to get segments from the command line (beta).
To use that run:

sponsorblock video_id

and pass your desired video_id

Roadmap

See the todo list for a list of features yet to be added and features already added. Also see the open 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 for more information.

Contact

Project Link: https://github.com/wasi-master/sponsorblock.py

Discord: Wasi Master#6969

Email: [email protected]