{"id":15497628,"url":"https://github.com/techouse/flask-docs-parser","last_synced_at":"2026-04-30T00:31:20.797Z","repository":{"id":45374866,"uuid":"156449781","full_name":"techouse/flask-docs-parser","owner":"techouse","description":"Parse the Flask HTML documentation into a JSON format to be used with Algolia","archived":false,"fork":false,"pushed_at":"2024-02-04T10:19:43.000Z","size":28,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-02-20T01:58:28.663Z","etag":null,"topics":["documentation","flask","parser","python3"],"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/techouse.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-06T21:24:06.000Z","updated_at":"2021-12-16T22:57:48.000Z","dependencies_parsed_at":"2024-02-04T11:47:54.091Z","dependency_job_id":null,"html_url":"https://github.com/techouse/flask-docs-parser","commit_stats":{"total_commits":20,"total_committers":2,"mean_commits":10.0,"dds":0.4,"last_synced_commit":"ea0b0ff413009ab7b86de338a8c9c90f0b4b2f6d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/techouse/flask-docs-parser","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techouse%2Fflask-docs-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techouse%2Fflask-docs-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techouse%2Fflask-docs-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techouse%2Fflask-docs-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/techouse","download_url":"https://codeload.github.com/techouse/flask-docs-parser/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techouse%2Fflask-docs-parser/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32449666,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T22:27:22.272Z","status":"ssl_error","status_checked_at":"2026-04-29T22:10:49.234Z","response_time":110,"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":["documentation","flask","parser","python3"],"created_at":"2024-10-02T08:40:20.448Z","updated_at":"2026-04-30T00:31:20.759Z","avatar_url":"https://github.com/techouse.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flask docs parser\n\n## Requirements:\n\n- Python 3.4+\n\n## Installation and usage\n```bash\npython3 -m venv env\nsource env/bin/activate\npip install -r requirements.txt\nsh get_docs.sh\npython parser.py\n```\n\nThe above commands will make a virtual environment in a folder called `env` and install all the requirements listed in `requirements.txt` into that virtual environment.\nOnce that is done running `sh get_docs.sh` will `clone` the `git` repository of [pallets/flask](https://github.com/pallets/flask) and build the Flask HTML documentation using Sphinx.\nThen running `python parser.py` will parse that documentation.\nIt will output a file called `data.json` which you can later use to your avail.\n\nThe output JSON file looks like this:\n```json\n[\n    {\n        \"version\": \"2.0.x\",\n        \"id\": \"flask.Flask.default_config\",\n        \"title\": \"Flask.default_config\",\n        \"permalink\": \"https://flask.palletsprojects.com/en/2.0.x/api/#flask.Flask.default_config\",\n        \"categories\": [\n            \"Flask\"\n        ],\n        \"default\": \"{'APPLICATION_ROOT': '/', 'DEBUG': None, 'ENV': None, 'EXPLAIN_TEMPLATE_LOADING': False, 'JSONIFY_MIMETYPE': 'application/json', 'JSONIFY_PRETTYPRINT_REGULAR': False, 'JSON_AS_ASCII': True, 'JSON_SORT_KEYS': True, 'MAX_CONTENT_LENGTH': None, 'MAX_COOKIE_SIZE': 4093, 'PERMANENT_SESSION_LIFETIME': datetime.timedelta(days31), 'PREFERRED_URL_SCHEME': 'http', 'PRESERVE_CONTEXT_ON_EXCEPTION': None, 'PROPAGATE_EXCEPTIONS': None, 'SECRET_KEY': None, 'SEND_FILE_MAX_AGE_DEFAULT': datetime.timedelta(seconds43200), 'SERVER_NAME': None, 'SESSION_COOKIE_DOMAIN': None, 'SESSION_COOKIE_HTTPONLY': True, 'SESSION_COOKIE_NAME': 'session', 'SESSION_COOKIE_PATH': None, 'SESSION_COOKIE_SAMESITE': None, 'SESSION_COOKIE_SECURE': False, 'SESSION_REFRESH_EACH_REQUEST': True, 'TEMPLATES_AUTO_RELOAD': None, 'TESTING': False, 'TRAP_BAD_REQUEST_ERRORS': None, 'TRAP_HTTP_EXCEPTIONS': False, 'USE_X_SENDFILE': False}\",\n        \"content\": \"Default configuration parameters.\"\n    }\n]\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechouse%2Fflask-docs-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftechouse%2Fflask-docs-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechouse%2Fflask-docs-parser/lists"}