{"id":17903727,"url":"https://github.com/pirogoeth/tubedlapi","last_synced_at":"2026-01-22T18:02:54.820Z","repository":{"id":50209177,"uuid":"119940428","full_name":"pirogoeth/tubedlapi","owner":"pirogoeth","description":"Youtube-DL API","archived":false,"fork":false,"pushed_at":"2022-12-08T00:56:17.000Z","size":64,"stargazers_count":1,"open_issues_count":8,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-08T07:41:25.304Z","etag":null,"topics":["api","python","python3","rest-api","youtube-dl"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pirogoeth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-02T06:12:10.000Z","updated_at":"2019-01-14T23:22:52.000Z","dependencies_parsed_at":"2023-01-25T01:45:51.232Z","dependency_job_id":null,"html_url":"https://github.com/pirogoeth/tubedlapi","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/pirogoeth/tubedlapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pirogoeth%2Ftubedlapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pirogoeth%2Ftubedlapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pirogoeth%2Ftubedlapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pirogoeth%2Ftubedlapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pirogoeth","download_url":"https://codeload.github.com/pirogoeth/tubedlapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pirogoeth%2Ftubedlapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28667881,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-22T17:07:18.858Z","status":"ssl_error","status_checked_at":"2026-01-22T17:05:02.040Z","response_time":144,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","python","python3","rest-api","youtube-dl"],"created_at":"2024-10-28T16:41:22.076Z","updated_at":"2026-01-22T18:02:54.775Z","avatar_url":"https://github.com/pirogoeth.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tubedlapi\n\n`tubedlapi` is a Flask application that wraps [`youtube-dl`](https://github.com/rg3/youtube-dl) to provide a simple, RESTful interface for downloading videos.\n\n## Roadmap\n\n- [ ] Integration and unit tests\n- [ ] Dockerfile for development and production usage\n- [ ] Webhooks on job completion/failure\n- [ ] Test with PostgreSQL and MariaDB/MySQL(?)\n- [ ] Interface for downloading completed jobs(?)\n\n## Installation and Usage\n\n    git clone https://github.com/pirogoeth/tubedlapi.git\n    cd tubedlapi\n    mkvirtualenv -p python3 tubedlapi\n    pip install -r requirements.txt\n    pip install -e .\n\n    source env.example\n\n    # For development\n    tubedlapi\n\n    # For production\n    pip install gunicorn\n    gunicorn tubedlapi.app:wsgi\n\n## Demo\n\nA short ASCIIcast of `tubedlapi` in action:\n\n[![asciicast](https://asciinema.org/a/168904.png)](https://asciinema.org/a/168904)\n\n### Configuration\n\n`tubedlapi` is completely configured through environment variables.  An example configuration is included in [`env.example`](/env.example).  Settings are loaded and handled using a [Settings component](/src/tubedlapi/components/settings.py).\n\n### Crypto Settings\n\nAs `tubedlapi` allows creating upload destinations for jobs, the (potentially secret) connection information must be stored in the database.\n\nEncrypted storage is accomplished using [encrypted blob fields](/src/tubedlapi/model/fields.py), with `PBKDF2HMAC` for deriving an encryption secret and `ChaCha20Poly1305` for performing encryption of secrets. See [`crypto.py`](/src/tubedlapi/util/crypto.py) for implementation details.\n\nFor crypto settings, *at least* a `CRYPTO_SECRET` is required.  A `CRYPTO_SALT` is *highly recommended* unless you are using an in-memory database, in which case, it does not matter.\n\n## API\n\nThe API is documented with OpenAPI / Swagger using the [Flasgger](https://github.com/rochacbruno/flasgger) plugin.\n\nAll API routes are in the [`tubedlapi.routes`](/src/tubedlapi/routes) package and have documentation in the route function docstrings.\n\nTo view OpenAPI documentation, start up the development server and navigate to `http://localhost:5000/apidocs`.\n\n## Development\n\nThe entirety of this project is written in Python 3 with Flask as the web backend and Peewee as the database backend.\n\nSetup of a development environment for `tubedlapi` should be quick and painless:\n\n    mkvirtualenv -p python3 tubedlapi\n    pip install -r requirements\n    pip install -e .[develop]\n\n`tubedlapi` also includes a [Sentry](https://getsentry.io) integration for easier debugging in dev and prod.  Talk with me and I can possibly set you up on my Sentry instance for development.\n\n### Components\n\n`tubedlapi` uses [`diecast`](https://github.com/pirogoeth/diecast) to provide a component and dependency injection system, which makes sharing reusable code chunks (such as the `CryptoProvider` or `Settings` components) much easier.  Check out the [`diecast` docs and examples](https://github.com/pirogoeth/diecast/blob/master/README.md) for more information.\n\n## Contributing\n\nPull requests are welcomed and encouraged.  Feel free to ask questions via the issue tracker or anywhere else (such as [Gitter](https://gitter.im/pirogoeth)).\n\nIf you're submitting a PR, please install [`pre-commit`](https://github.com/pre-commit/pre-commit) and install the local git pre-commit hook to run code and style checks.\n\nAny contributions will be greatly appreciated \u003c3.\n\n## License\n\nLicensed under MIT. See [LICENSE](/LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpirogoeth%2Ftubedlapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpirogoeth%2Ftubedlapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpirogoeth%2Ftubedlapi/lists"}