https://github.com/lartza/sbbrowser

Web frontend to browse the SponsorBlock database written with Django
https://github.com/lartza/sbbrowser

django sponsorblock

Last synced: 3 days ago
JSON representation

Web frontend to browse the SponsorBlock database written with Django

• Host: GitHub
• URL: https://github.com/lartza/sbbrowser
• Owner: Lartza
• License: agpl-3.0
• Created: 2020-09-20T06:29:10.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-01-17T23:37:12.000Z (25 days ago)
• Last Synced: 2025-01-18T00:25:33.755Z (25 days ago)
• Topics: django, sponsorblock
• Language: Python
• Homepage: https://sb.ltn.fi/
• Size: 184 KB
• Stars: 43
• Watchers: 2
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# SBTools

SBTools is a Django web service for browsing the SponsorBlock database (https://sponsor.ajay.app/).  

The project is tested to work on Python 3.8.

There is a publicly hosted instance of this service at https://sb.ltn.fi/

## Installation & Usage

To install the requirements on Linux, `psycopg2` needs to be compiled. pip does this automatically if build requirements are available. https://www.psycopg.org/docs/install.html#build-prerequisites

An alternative to building is to use `psycopg2-binary`. You can edit requirements.txt or install it manually if you can't or don't want to build.   

The binary version is not recommended for production by psycopg2 developers and could in certain situations lead to problems, which is why we default to building. https://www.psycopg.org/docs/install.html#psycopg-vs-psycopg-binary

### Development

For development you can clone the repo, install requirements.txt (in a venv preferably) and run the Django development server with `(venv) python manage.py runserver`.

Database should still be migrated to PostgreSQL (e.g. `pgloader database.db postgresql://sponsorblock@localhost/sponsorblock`) and modified with `INSERT INTO config VALUES ('updated', now());` or similar.  

Database connection details are configured in SBtools/settings/development.py  

The SECRET_KEY doesn't need changing necessarily.

### Production

There are helpful files under docs/ for deploying the service.

All examples assume a Linux user `sponsorblock` with home folder at `/srv/sponsorblock/`

and proxying the site through Nginx with webroot at `/srv/http/sbtools/`

You should also have a PostgreSQL user `sponsorblock` with a database called `sponsorblock`.  

Based on brief testing, using the SQLite database has abysmal performance.

Installing before running could look like the following

```bash

[sponsorblock]$ git clone https://github.com/Lartza/SBbrowser.git

[sponsorblock]$ python -m venv /srv/sponsorblock/SBbrowser/venv

[sponsorblock]$ /srv/sponsorblock/SBbrowser/venv/bin/pip install -r /srv/sponsorblock/SBbrowser/requirements.txt

[sponsorblock]$ /srv/sponsorblock/SBbrowser/venv/bin/pip install gunicorn

[sponsorblock]$ DB_PASSWORD='changeme' SECRET_KEY='changeme' STATIC_ROOT='/srv/http/sbtools/static/' DJANGO_SETTINGS_MODULE='SBtools.settings.production' /srv/sponsorblock/SBbrowser/venv/bin/python /srv/sponsorblock/SBbrowser/manage.py collectstatic --noinput

```

The DB_PASSWORD, SECRET_KEY and STATIC_ROOT variables are also present in files under docs/ and should be modified as needed.  

SECRET_KEY should be a large random value and kept secret. You could generate one on https://djecrety.ir/

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

[AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html)