{"id":17403728,"url":"https://github.com/link89/webq","last_synced_at":"2025-03-27T22:34:16.298Z","repository":{"id":218454483,"uuid":"740136627","full_name":"link89/webq","owner":"link89","description":null,"archived":false,"fork":false,"pushed_at":"2024-01-22T02:19:14.000Z","size":141,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-02T00:47:49.055Z","etag":null,"topics":[],"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/link89.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2024-01-07T16:27:34.000Z","updated_at":"2024-01-22T02:18:49.000Z","dependencies_parsed_at":"2024-01-22T03:40:06.570Z","dependency_job_id":null,"html_url":"https://github.com/link89/webq","commit_stats":null,"previous_names":["link89/webq"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/link89%2Fwebq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/link89%2Fwebq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/link89%2Fwebq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/link89%2Fwebq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/link89","download_url":"https://codeload.github.com/link89/webq/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245937239,"owners_count":20696974,"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":[],"created_at":"2024-10-16T19:07:29.647Z","updated_at":"2025-03-27T22:34:16.255Z","avatar_url":"https://github.com/link89.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WebQ\n\nA queue system for web applications.\n\n## Introduction\nWebQ is a backend service designed for web applications to provide queue-related capabilities.\nCurrently, WebQ provides the following services:\n\n* job-queue: A producer-consumer job queue, suitable for building crowd-sourcing applications.\n\n## Installation\n```\npip install webq\n```\n\n## Getting Started\n### Generate a config file\nYou can generate a config file by running the following command as a starting point:\n```\nwebq config-init \u003e config.yml\n```\n\n### Initialize the database\nIf you are running the service for the first time, you need to initialize the database by running the following command:\n```\nwebq db-init config.yml\n```\n\nThis command will initialize the database according to the configuration file. It will create an `admin` user during the initialization. The password of the `admin` user will be printed out in the console. You can use this password to login to the admin user.\n\n### Running the service\nYou can run the service by running the following command:\n```\nwebq start config.yml\n```\nAfter the service is started, you can visit the OpenAPI documentation at `{base_url}/docs`.\n\n## Services\n\n### Job Queue\n`job-queue` is a producer-consumer job queue. The producer can submit `job` to the queue with data or files payload. Then consumer can apply jobs from queue and submit the result (named `commit`) back to the queue when the job is resolved. And then the producer can retrieve the result from the queue.\n\n\n\n## TODO\n* [ ] E2E test\n* [ ] Command line interface for basic operations\n* [ ] Third party authentication\n* [ ] Webhook support\n* [ ] Refactor","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flink89%2Fwebq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flink89%2Fwebq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flink89%2Fwebq/lists"}