{"id":13740399,"url":"https://github.com/roedoejet/convertextract","last_synced_at":"2026-01-16T12:24:06.031Z","repository":{"id":62564680,"uuid":"70942049","full_name":"roedoejet/convertextract","owner":"roedoejet","description":"Extract and find/replace text based on arbitrary correspondences while preserving original file formatting. This library is a fork from the Textract library by Dean Malmgren.","archived":false,"fork":false,"pushed_at":"2023-09-08T22:23:02.000Z","size":61180,"stargazers_count":11,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-22T20:16:08.910Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","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/roedoejet.png","metadata":{"files":{"readme":"README.md","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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-10-14T19:43:37.000Z","updated_at":"2023-08-25T10:22:11.000Z","dependencies_parsed_at":"2024-01-07T18:10:39.320Z","dependency_job_id":null,"html_url":"https://github.com/roedoejet/convertextract","commit_stats":{"total_commits":146,"total_committers":5,"mean_commits":29.2,"dds":"0.17123287671232879","last_synced_commit":"833c92a5f70b96fe4aa9a626ef7c7f6d47afa148"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/roedoejet/convertextract","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roedoejet%2Fconvertextract","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roedoejet%2Fconvertextract/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roedoejet%2Fconvertextract/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roedoejet%2Fconvertextract/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roedoejet","download_url":"https://codeload.github.com/roedoejet/convertextract/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roedoejet%2Fconvertextract/sbom","scorecard":{"id":782492,"data":{"date":"2025-08-11","repo":{"name":"github.com/roedoejet/convertextract","commit":"899e21c3152ff1dd565d1f7e841ff516c489ffd9"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/bump.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 3.2.16 not signed: https://api.github.com/repos/roedoejet/convertextract/releases/43245049","Warn: release artifact 3.2.15 not signed: https://api.github.com/repos/roedoejet/convertextract/releases/42974676","Warn: release artifact 3.2.14 not signed: https://api.github.com/repos/roedoejet/convertextract/releases/39877008","Warn: release artifact 3.2.13 not signed: https://api.github.com/repos/roedoejet/convertextract/releases/39739004","Warn: release artifact 3.2.12 not signed: https://api.github.com/repos/roedoejet/convertextract/releases/34090145","Warn: release artifact 3.2.16 does not have provenance: https://api.github.com/repos/roedoejet/convertextract/releases/43245049","Warn: release artifact 3.2.15 does not have provenance: https://api.github.com/repos/roedoejet/convertextract/releases/42974676","Warn: release artifact 3.2.14 does not have provenance: https://api.github.com/repos/roedoejet/convertextract/releases/39877008","Warn: release artifact 3.2.13 does not have provenance: https://api.github.com/repos/roedoejet/convertextract/releases/39739004","Warn: release artifact 3.2.12 does not have provenance: https://api.github.com/repos/roedoejet/convertextract/releases/34090145"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2017-48 / GHSA-chqf-hx79-gxc6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/bump.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/roedoejet/convertextract/bump.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/bump.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/roedoejet/convertextract/bump.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/bump.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/roedoejet/convertextract/bump.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/bump.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/roedoejet/convertextract/bump.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/roedoejet/convertextract/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/roedoejet/convertextract/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/roedoejet/convertextract/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/roedoejet/convertextract/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/roedoejet/convertextract/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/roedoejet/convertextract/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/roedoejet/convertextract/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/roedoejet/convertextract/release.yml/master?enable=pin","Warn: containerImage not pinned by hash: tests/Dockerfile:1: pin your Docker image by updating ubuntu:12.04 to ubuntu:12.04@sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005","Warn: pipCommand not pinned by hash: provision/python.sh:12","Warn: pipCommand not pinned by hash: provision/python.sh:15","Warn: pipCommand not pinned by hash: provision/travis-mock.sh:12","Warn: pipCommand not pinned by hash: .github/workflows/bump.yml:22","Warn: pipCommand not pinned by hash: .github/workflows/bump.yml:23","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:23","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:24","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:25","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:50","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:51","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:52","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:53","Info:   0 out of   9 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   3 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of  12 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}}]},"last_synced_at":"2025-08-23T05:14:29.644Z","repository_id":62564680,"created_at":"2025-08-23T05:14:29.644Z","updated_at":"2025-08-23T05:14:29.644Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478600,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"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":[],"created_at":"2024-08-03T04:00:47.301Z","updated_at":"2026-01-16T12:24:05.996Z","avatar_url":"https://github.com/roedoejet.png","language":"HTML","readme":"# convertextract\n========\n\n[![Build Status](https://travis-ci.org/roedoejet/textract.svg?branch=master)](https://travis-ci.org/roedoejet/textract)\n[![Version](https://img.shields.io/pypi/v/convertextract.svg)](https://warehouse.python.org/project/convertextract/)\n[![Coverage Status](https://coveralls.io/repos/github/roedoejet/textract/badge.svg?branch=master)](https://coveralls.io/github/roedoejet/textract?branch=master)\n\n\nExtract and find/replace text based on arbitrary correspondences. This library is a fork from the Textract library by Dean Malmgren. https://github.com/deanmalmgren/textract\n\n\n# Documentation\n\n## Installation\nTo install, you must have Python 3.4+ and pip installed.\n```{r, engine='python', count_lines}\npip install convertextract\n```\nSome source libraries need to be installed for different operating systems to support various file formats. Visit \u003chttp://textract.readthedocs.org/en/latest/installation.html\u003e for documentation.\n\n=========\n\n## Basic CLI Use\n\nSome basic Textract functions are preserved. Please visit \u003chttp://textract.readthedocs.org\u003e for documentation.\n\n#### Converting a file based on pre-existing Mappings in the G2P library\n\nUnder the hood, convertextract uses the [g2p](https://github.com/roedoejet/g2p) library to do conversions. There are many mappings available through that library. For a list of all possible mappings, please visit \u003chttps://g2pstudio-herokuapp.com/api/v1/langs\u003e.\n\nFor this type of call, convertextract requires three arguments:\n\n1. A file containing text to convert (as of Version 1.0.4, this includes **.pptx**, **.docx**, **.xlsx**, and **.txt**)\n2. A code corresponding to the input language of the text.\n3. A code corresponding to the desired output language of the text.\n\nRunning the command:\n```{r, engine='python', count_lines}\nconvertextract path/to/foo.docx -il eng-ipa -ol eng-arpabet\n```\n\nWill produce a new file `path/to/foo_converted.docx` which will contain the same content as `path/to/foo.docx` but with find/replace performed for all correspondences listed in the mapping between English IPA (eng-ipa) and English Arpabet (eng-arpabet). \n\n#### Converting a file based on custom mapping\nIf the mapping you want is not supported by g2p, you should make a pull request there to have it included! Otherwise, you can use a custom file.\n\nRunning the command:\n```{r, engine='python', count_lines}\nconvertextract path/to/foo.docx -m path/to/rules.csv\n```\n\nWill produce a new file `path/to/foo_converted.docx` which will contain the same content as `path/to/foo.docx` but with find/replace performed for all correspondences listed in the mapping at `path/to/rules.csv`. \n\n#### Creating an .xlsx/.csv/.psv/.tsv correspondence sheet\nYour correspondence sheet must be set up as follows:\n\n|    in   |  out           |\n|:-:|:-:|\n| aa| å| \n| oe| ø|\n| ae| æ|\n\nHere, this correspondence sheet (do not include headers like \"replace with\" or \"find\") would replace all instances of aa, oe, or ae in a given file with å, ø, or æ respectively.\n\n#### Supported conversions\n\nAs of Version 3.0, any mappings that are valid in the g2p library are supported. Here are a few:\n\n* Heiltsuk Doulos Font -\u003e Unicode\n```{r, engine='python', count_lines}\nconvertextract path/to/foo.docx -il hei -ol hei-doulos\n```\n\n* Heiltsuk Times Font -\u003e Unicode\n```{r, engine='python', count_lines}\nconvertextract path/to/foo.docx -il hei -ol hei-times\n```\n\n* Tsilhqot'in Doulos Font -\u003e Unicode\n```{r, engine='python', count_lines}\nconvertextract path/to/foo.docx -il clc -ol clc-doulos\n```\n\n* Navajo Times Font -\u003e Unicode\n```{r, engine='python', count_lines}\nconvertextract path/to/foo.docx -il nav -ol nav-times\n```\n\n#### Using Regular Expressions\n\nAs of Version 1.5, there is support for Regular Expressions. If you do not need to use context-sensitive conversions, you do not need to include them. However, if you do, you should set up your correspondence sheet as follows:\n\n|    in   |  out  |  context_before | context_after |\n|:-:|:-:|:-:|:-:|\n| aa| å|[k,d]|$| \n| aa| æ|t|$|\n| aa| a:|||\n\nFor more information on how the g2p is acutally processed, please visit \u003chttps://github.com/roedoejet/g2p\u003e.\n\n#### Use as Python package\nYou can use the package in a Python script, which returns converted text, but without formatting. Running the script will still create a `foo_converted.docx` file.\n```python\nimport convertextract\ntext = convertextract.process('foo.docx', mapping='bar.xlsx')\n```\n\nYou can also use convertextract to just convert text in Python using `process_text`.\n\n```python\nimport convertextract\ntext = convertextract.process_text('test', mapping=[{'in': 't', 'out': 'p', 'context_before': '^', 'context_after': 'e'}])\n```\n\n## Use with GUI (Graphical User Interface)\n\nConvertextract can also run in a GUI (for Mac 10.14.6 or higher **only**)\n\n### Installing the GUI\nTo download the app, go to [https://github.com/roedoejet/convertextract/releases](https://github.com/roedoejet/convertextract/releases) and select the most recent version.\n\n![download](https://raw.githubusercontent.com/roedoejet/convertextract/master/docs/assets/download.png)\n\nClick to unzip the file, and then *right-click* and select `open`. You must *right-click* or the Mac permissions will not allow you to open the app.\n![unzip](https://raw.githubusercontent.com/roedoejet/convertextract/master/docs/assets/unzip.png)\n![open](https://raw.githubusercontent.com/roedoejet/convertextract/master/docs/assets/open.png)\n\n### Using the GUI\nThe Convertextract app has four arguments:\n\n1.  A file containing text to convert (As of version 3.2.2 **.csv**,\n **.psv**, **.tsv**, **.doc**, **.docx**, **.txt**, **.eaf**, **.json**, **.pptx**, **.html**, **.xls**, **.xlsx** are supported).\n\n2.  A code that specifies the desired encoding, for example `UTF-8`.\n\n3. A code corresponding to the input language of the text.\n    \n4.  A code corresponding to the desired output language of the text.\n\nThere is also the option for custom g2p lookup tables if your mapping is not already in the [g2p](https://github.com/roedoejet/g2p) library.\n\n![gui](https://raw.githubusercontent.com/roedoejet/convertextract/master/docs/assets/gui.png)\n\nThe GUI will produce a new file `path/to/foo_converted.docx` which will contain the same content as `path/to/foo.docx` but with find/replace performed for all correspondences listed in the mapping. The file format will remain the same as the input file.\n\n# Citation\n\nIf you use convertextract in published work, please cite it. To cite this work, please use the following (APA):\n\nPine, A., \u0026 Turin, M. (2018). Seeing the Heiltsuk orthography from font encoding through to Unicode: A case study using convertextract. In Proceedings of the LREC 2018 Workshop “CCURL 2018–Sustaining knowledge diversity in the digital age” (pp. 27-30). European Language Resources Association.\n\nor BibTex:\n\n```\n@inproceedings{pine2018convertextract,\n  title={{Seeing the Heiltsuk orthography from font encoding through to Unicode: A case study using convertextract}},\n  author={Pine, Aidan and Turin, Mark},\n  booktitle={{Proceedings of the LREC 2018 Workshop “CCURL 2018--Sustaining knowledge diversity in the digital age”}},\n  pages={27--30},\n  year={2018},\n  organization={{European Language Resources Association}}\n}\n```\n\n","funding_links":[],"categories":["Software"],"sub_categories":["Utilities"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froedoejet%2Fconvertextract","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froedoejet%2Fconvertextract","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froedoejet%2Fconvertextract/lists"}