Awesome
<!-- 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 API
Built With
<!-- GETTING STARTED -->Getting Started
To install sponsorblock.py:
Prerequisites
You'll need to have python installed in order to use the extension
Installation
-
Installing via pip
-
Directly installing via pip (Recommended)
pip install sponsorblock.py
-
Installing using pip and git
pip install git+https://github.com/wasi-master/sponsorblock.py.git
-
-
Cloning then installing
-
Clone the repo
git clone https://github.com/wasi-master/sponsorblock.py.git
-
Changing the current working directory to the directory of the project
cd sponsorblock.py
-
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 -->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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - 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: arianmollik323@gmail.com