{"id":22574824,"url":"https://github.com/thoth-station/user-api","last_synced_at":"2025-04-10T16:10:30.997Z","repository":{"id":37502799,"uuid":"118607282","full_name":"thoth-station/user-api","owner":"thoth-station","description":"Web Service exposing Thoth functions to the RESTful worlds","archived":false,"fork":false,"pushed_at":"2023-10-02T23:46:17.000Z","size":17462,"stargazers_count":8,"open_issues_count":11,"forks_count":18,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-24T13:51:22.661Z","etag":null,"topics":["ai-stacks","artificial-intelligence","hacktoberfest","software-quality","thoth"],"latest_commit_sha":null,"homepage":"https://thoth-station.github.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thoth-station.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","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-01-23T12:26:42.000Z","updated_at":"2024-12-12T10:18:03.000Z","dependencies_parsed_at":"2023-02-14T17:46:33.243Z","dependency_job_id":null,"html_url":"https://github.com/thoth-station/user-api","commit_stats":null,"previous_names":[],"tags_count":100,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thoth-station%2Fuser-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thoth-station%2Fuser-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thoth-station%2Fuser-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thoth-station%2Fuser-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thoth-station","download_url":"https://codeload.github.com/thoth-station/user-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248250774,"owners_count":21072683,"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","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":["ai-stacks","artificial-intelligence","hacktoberfest","software-quality","thoth"],"created_at":"2024-12-08T03:08:06.448Z","updated_at":"2025-04-10T16:10:30.981Z","avatar_url":"https://github.com/thoth-station.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Thoth User-facing API\n---------------------\n\n.. image:: https://img.shields.io/github/v/tag/thoth-station/user-api?style=plastic\n  :target: https://github.com/thoth-station/user-api/releases\n  :alt: GitHub tag (latest by date)\n\n.. image:: https://quay.io/repository/thoth-station/user-api/status\n  :target: https://quay.io/repository/thoth-station/user-api?tab=tags\n  :alt: Quay - Build\n\n.. image:: https://api.codacy.com/project/badge/Grade/d8f62cde59b84854ac425d148570f1ab\n   :alt: Codacy Badge\n   :target: https://app.codacy.com/app/thoth-station/user-api?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=thoth-station/user-api\u0026utm_campaign=Badge_Grade_Dashboard\n\nThoth Deployment\n================\n\nYou can find Thoth's deployment at `khemenu.thoth-station.ninja\n\u003chttps://khemenu.thoth-station.ninja/\u003e`__.\n\nTalking to API\n==============\n\nUser API is the main interaction point for a user or bot with Thoth. The API\nitself exposes endpoints that are well documented using OpenAPI (see\n``openapi`` directory present in the repo). There are exposed only endpoints\nthat can be useful for a user in some way.\n\nIf you would like to programmatically access this API service, the preferred\nway for interaction is the autogenerated swagger-client available in the\n`Thamos repository \u003chttps://github.com/thoth-station/thamos\u003e`__ (see\nautogenerated documentation for more info). You can be also ensured that this\nclient is kept up2date respecting the current API state.\n\nInstallation and deployment\n###########################\n\nThe service is built using OpenShift Source-to-Image and deployed automatically\nwith Thoth's deployment available in the `thoth-station/thoth-application\nrepository \u003chttps://github.com/thoth-station/thoth-application\u003e`__.\n\nRunning User API locally\n########################\n\nUser API can be run locally in a mode when it still talks to the cluster.\nTo run User API locally, create ``.env`` file out out ``.env.template``\nand adjust environment variable values as desired (see `thoth-station/storages\n\u003chttps://github.com/thoth-station/storages/\u003e`__ for more info):\n\n.. code-block:: console\n\n  cp .env.template .env\n  vim .env\n\nOnce the environment is properly setup, you can run User API locally:\n\n.. code-block:: console\n\n  pipenv install\n  pipenv run gunicorn thoth.user_api.openapi_server:app --config gunicorn.conf.py\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthoth-station%2Fuser-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthoth-station%2Fuser-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthoth-station%2Fuser-api/lists"}