{"id":15009751,"url":"https://github.com/aidenybai/docscan","last_synced_at":"2025-10-03T19:30:20.064Z","repository":{"id":104100189,"uuid":"197672980","full_name":"aidenybai/docscan","owner":"aidenybai","description":"👓 Scans documents and returns strings","archived":true,"fork":false,"pushed_at":"2019-07-19T00:40:49.000Z","size":8,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-22T19:38:59.469Z","etag":null,"topics":["docs","docx","pdf","py","xml"],"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/aidenybai.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":"2019-07-19T00:11:17.000Z","updated_at":"2023-02-06T08:53:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"7cc7cf35-74e9-4be5-9ea3-dc96da31ec0f","html_url":"https://github.com/aidenybai/docscan","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aidenybai/docscan","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidenybai%2Fdocscan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidenybai%2Fdocscan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidenybai%2Fdocscan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidenybai%2Fdocscan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aidenybai","download_url":"https://codeload.github.com/aidenybai/docscan/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidenybai%2Fdocscan/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278217052,"owners_count":25950032,"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-03T02:00:06.070Z","response_time":53,"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":["docs","docx","pdf","py","xml"],"created_at":"2024-09-24T19:28:19.278Z","updated_at":"2025-10-03T19:30:19.804Z","avatar_url":"https://github.com/aidenybai.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docscan \n\nDocscan is a lightweight document scanner. It allows users to open up document types and return the information inside as strings via regex.\n\n**Requirements**:\n1. zipfile\n2. io\n3. re\n4. XML\n\n**Usage**:\n*Note: fileName must be in the directory*\nExample: DocuScan(\"C:\\\\Users\\\\You\\\\Desktop\\\\folder1\\\\test.pdf\")\n1. Instantiate `class Docscan('fileName')`.\n2. use `print(variable.returnFileText())`\n3. use `print(variable.executeRegex('regex here'))`\n4. use `print(executeHeaderRegex('regex here'))`\n5. use `print(executeFooterRegex('regex here'))`\n\n**Methods**:\n1. `returnFileText()` - Returns the text of a file.\n2. `executeRegex(regexExpression)` - creates a list of all matching cases of regexExpression\n3. `executeHeaderRegex(regularExpression)` - creates a list of all matching cases of regexExpression in the header XML.\n4. `executeFooterRegex(regularExpression)` - creates a list of all matching cases of regexExpression in the Footer XML.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faidenybai%2Fdocscan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faidenybai%2Fdocscan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faidenybai%2Fdocscan/lists"}