{"id":15134716,"url":"https://github.com/tolstoyevsky/cusdeb-helpik","last_synced_at":"2026-02-11T12:32:19.166Z","repository":{"id":43387719,"uuid":"250032898","full_name":"tolstoyevsky/cusdeb-helpik","owner":"tolstoyevsky","description":"Microservice intended for gathering synopses from CusDeb Wiki to display them on the client","archived":false,"fork":false,"pushed_at":"2023-07-20T15:10:21.000Z","size":19,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-08-26T17:53:54.303Z","etag":null,"topics":["aiohttp","cusdeb","mediawiki","mediawiki-api","python3","restful-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tolstoyevsky.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":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-25T16:34:17.000Z","updated_at":"2021-11-02T14:11:14.000Z","dependencies_parsed_at":"2024-09-21T09:01:13.901Z","dependency_job_id":null,"html_url":"https://github.com/tolstoyevsky/cusdeb-helpik","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tolstoyevsky/cusdeb-helpik","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolstoyevsky%2Fcusdeb-helpik","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolstoyevsky%2Fcusdeb-helpik/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolstoyevsky%2Fcusdeb-helpik/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolstoyevsky%2Fcusdeb-helpik/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tolstoyevsky","download_url":"https://codeload.github.com/tolstoyevsky/cusdeb-helpik/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolstoyevsky%2Fcusdeb-helpik/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29332988,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T06:13:03.264Z","status":"ssl_error","status_checked_at":"2026-02-11T06:12:55.843Z","response_time":97,"last_error":"SSL_read: 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":["aiohttp","cusdeb","mediawiki","mediawiki-api","python3","restful-api"],"created_at":"2024-09-26T05:23:54.755Z","updated_at":"2026-02-11T12:32:19.152Z","avatar_url":"https://github.com/tolstoyevsky.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CusDeb Helpik\n\nCusDeb Helpik is a microservice intended primarily, but **not** exclusively, for gathering synopses from [CusDeb Wiki](http://wiki.cusdeb.com) to display them on the [client](https://github.com/tolstoyevsky/cusdeb-web-client).\n\nHelpik interacts directly with the [MediaWiki API](https://mediawiki.org/wiki/API:Main_page) and, therefore, it can be used with any wiki based on MediaWiki.\n\n## Installation\n\n```\n$ git clone https://github.com/tolstoyevsky/cusdeb-helpik.git\n$ virtualenv -ppython3 cusdeb-helpik-env\n$ source cusdeb-helpik-env/bin/activate\n(cusdeb-helpik-env) $ cd cusdeb-helpik\n(cusdeb-helpik-env) $ python3 setup.py install\n(cusdeb-helpik-env) $ python3 bin/server.py\n```\n\n### How to run tests\n\n```\n(cusdeb-helpik-env) $ python3 -m pytest test/run_tests.py\n```\n\n## API\n\n* **URI:** `/helpik_api/`\n* **Method:** `GET`\n* **Params**\n  * `page=[string]`\n  * `lang=[string]`\n  * `sec=[string]`\n\n  `page` is the name of the target page.\n\n  `lang` is the language of the target page. If the page in the specified language doesn't exist, Helpik fallbacks to English. If the fallback doesn't work the microservice returns a 404 status code (see below).\n\n  `sec` allows, if passed, the client to fetch the synopsis of the specified section on the target page instead of the synopsis of the page itself.\n* **Success Response**\n  * **Code:** 200\n    * **Content:** `{\"text\": \"\u003ctext\u003e\", \"url\": \"\u003curl\u003e\"}`, where\n      * `\u003ctext\u003e` is the synopsis of either the target page or the specified section on the target page;\n      * `\u003curl\u003e` is the URL of the target page.\n* **Error Responses**\n  * **Code:** 404\n    * **Content:** None\n    * **Reason:** either the target page or the specified section on the target page doesn't exist.\n  * **Code:** 503\n    * **Content:** None\n    * **Reason:** the MediaWiki API is unavailable when invoking the `/helpik_api/` endpoint.\n\n## Authors\n\nSee [AUTHORS](AUTHORS.md).\n\n## Licensing\n\nCusDeb Helpik is available under the [Apache License, Version 2.0](LICENSE).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftolstoyevsky%2Fcusdeb-helpik","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftolstoyevsky%2Fcusdeb-helpik","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftolstoyevsky%2Fcusdeb-helpik/lists"}