Skip to main content

An unofficial wrapper for the SponsorBlock API

Project description


Logo

sponsorblock.py

A wrapper for the SponsorBlock API
Explore the docs »

View Demo · Report Bug · Request Feature

Contributors Forks Stargazers Issues Code Size MIT License Say Thanke Downloads last Month Downloads last Week Downloads last Day Version Documentation Status Tests Build Code style: black

Table of Contents

  1. About The Project
  2. Getting Started
  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

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: arianmollik323@gmail.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sponsorblock.py-0.2.3.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

sponsorblock.py-0.2.3-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file sponsorblock.py-0.2.3.tar.gz.

File metadata

  • Download URL: sponsorblock.py-0.2.3.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for sponsorblock.py-0.2.3.tar.gz
Algorithm Hash digest
SHA256 050129046749d1c53458ffdefc04e04927464bd94d1696cdefdfef65db4d7a57
MD5 052e0144f86e21f0a32d3de4e854913b
BLAKE2b-256 e59bffcce979bdecf63a40e63d6163951bc31cb4e5ab76d9626d0e058edfb0e6

See more details on using hashes here.

File details

Details for the file sponsorblock.py-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for sponsorblock.py-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 999617f38e10325207ab3902232f630c87235bd85cd76be7cf284b950a561eba
MD5 372634f75f56e47960789bdb43d83647
BLAKE2b-256 4a0f3bc2681346365c34c5c07003187739333b3d4eb26c7609b722679e49b423

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page