{"id":14986596,"url":"https://github.com/persephone-tools/persephone-web-api","last_synced_at":"2025-10-04T05:14:55.865Z","repository":{"id":68485718,"uuid":"129890395","full_name":"persephone-tools/persephone-web-API","owner":"persephone-tools","description":"Web API for use with the Persephone library","archived":false,"fork":false,"pushed_at":"2019-05-11T01:07:13.000Z","size":1011,"stargazers_count":8,"open_issues_count":33,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-08-26T12:23:59.150Z","etag":null,"topics":["open-api","persephone"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/persephone-tools.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"docs/support.rst","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-17T10:53:45.000Z","updated_at":"2020-09-04T17:04:03.000Z","dependencies_parsed_at":"2023-03-08T03:15:43.536Z","dependency_job_id":null,"html_url":"https://github.com/persephone-tools/persephone-web-API","commit_stats":{"total_commits":574,"total_committers":3,"mean_commits":"191.33333333333334","dds":0.259581881533101,"last_synced_commit":"9ab6db6ef42c823a3cde8579e6177703ac5646e8"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/persephone-tools/persephone-web-API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/persephone-tools%2Fpersephone-web-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/persephone-tools%2Fpersephone-web-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/persephone-tools%2Fpersephone-web-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/persephone-tools%2Fpersephone-web-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/persephone-tools","download_url":"https://codeload.github.com/persephone-tools/persephone-web-API/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/persephone-tools%2Fpersephone-web-API/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278266896,"owners_count":25958733,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["open-api","persephone"],"created_at":"2024-09-24T14:13:12.121Z","updated_at":"2025-10-04T05:14:55.831Z","avatar_url":"https://github.com/persephone-tools.png","language":"Python","readme":"Persephone-web-API (beta version)\n========================================\n\nThis is a web API for the the `persephone library \u003chttps://github.com/persephone-tools/persephone\u003e`_\n\nThis is a REST API that will provide the ability to interact with the Persephone transcription tools from over the network.\n\nThis API is based on the `OpenAPI 2.0 \u003chttps://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md\u003e`_ (formerly known as Swagger) standard which specifies API endpoints via API description files.\nThe API specification for this project can be found in a YAML file located in the repository at `./persephone_api/api_spec.yaml \u003chttps://github.com/persephone-tools/persephone-web-API/blob/master/persephone_api/api_spec.yaml\u003e`_\n\nThis file will show you all the endpoints that are supported but an easier way to get familiarity with the API is to use the API explorer frontend provided by the project. See the API explorer section of this README to get started with exploring the API.\n\nFor more information about the API specification see the `documentation page \u003chttps://persephone-web-api.readthedocs.io/en/latest/APIspecification.html\u003e`_.\n\nInstallation\n------------\n\nYou can install this package directly or use Docker.\n\nBecause this package depends on various system binaries (such as ffmpeg) being installed as well Python packages we recommend using the Docker container we have created.\nHowever you can also install this directly without a container as well if you wish, see the `installation documentation \u003chttps://persephone-web-api.readthedocs.io/en/latest/installation.html\u003e`_ page for more information.\n\n\nUsage\n-----\n\nWe have a Docker image that will automate the install and spin up the API server.\nA Docker image for this project is available at docker hub at `\"persephonetools/api:latest\"`\n\nAlternatively you can build the image locally as follows:\n\n.. code:: sh\n\n    docker build -t persephone-web-api:dev .\n\n\nThen to run it:\n\n.. code:: sh\n\n    docker run -p 8080:8080/tcp persephone-web-api:dev\n\n\nIf you are looking to use the whole stack the easiest way to get started is to use the docker-compose setup found in the `persephone-docker repository \u003chttps://github.com/aapeliv/persephone-docker\u003e`_ \nas this will automate the install and setup of this API server along with the `persephone web frontend \u003chttps://github.com/persephone-tools/persephone-frontend\u003e`_ that accesses the API.\n\nDocumentation\n-------------\n\nDocumentation can be found `here \u003chttps://persephone-web-api.readthedocs.io/en/latest/\u003e`_.\n\nThe web based documentation is automatically built from the files found in the `./docs/ \u003chttps://github.com/persephone-tools/persephone-web-API/tree/master/docs\u003e`_ directory in this repository.\n\nSupport\n-------\n\nIf you find an issue or bug with this code please open an issue on the `issues tracker \u003chttps://github.com/persephone-tools/persephone-web-API/issues\u003e`_.\nPlease use the `discussion mailing list \u003chttps://lists.persephone-asr.org/postorius/lists/discuss.lists.persephone-asr.org/\u003e`_ to discuss other questions regarding this project.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpersephone-tools%2Fpersephone-web-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpersephone-tools%2Fpersephone-web-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpersephone-tools%2Fpersephone-web-api/lists"}