| Name | textract-cli JSON |
| Version |
0.1
JSON |
| download |
| home_page | None |
| Summary | CLI for running files through AWS Textract |
| upload_time | 2024-03-29 18:49:12 |
| maintainer | None |
| docs_url | None |
| author | Simon Willison |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# textract-cli
[](https://pypi.org/project/textract-cli/)
[](https://github.com/simonw/textract-cli/releases)
[](https://github.com/simonw/textract-cli/actions/workflows/test.yml)
[](https://github.com/simonw/textract-cli/blob/master/LICENSE)
CLI for running files through AWS Textract
## Installation
Install this tool using `pip`:
```bash
pip install textract-cli
```
## Configuration
Any of the [methods for configuring](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html) `boto3` will work with this tool. Environment variables or a `~/.aws/config` file are good options here.
## Usage
To run Textract OCR against a JPEG or PNG file (must be smaller than 5MB):
```bash
textract-cli image.jpeg
```
This will output to standard out. To save to a file use this:
```bash
textract-cli image.jpeg > output.txt
```
Or use the `-o/--output` option like this:
```bash
textract-cli image.jpeg -o output.txt
```
For help, run:
```bash
textract-cli --help
```
You can also use:
```bash
python -m textract_cli --help
```
## Development
To contribute to this tool, first checkout the code. Then create a new virtual environment:
```bash
cd textract-cli
python -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
pip install -e '.[test]'
```
To run the tests:
```bash
pytest
```
Raw data
{
"_id": null,
"home_page": null,
"name": "textract-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Simon Willison",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a0/5c/de8cc5e2c38e41955a9b0185e83d1c38128e176c53b87d23597fcbc4df16/textract-cli-0.1.tar.gz",
"platform": null,
"description": "# textract-cli\n\n[](https://pypi.org/project/textract-cli/)\n[](https://github.com/simonw/textract-cli/releases)\n[](https://github.com/simonw/textract-cli/actions/workflows/test.yml)\n[](https://github.com/simonw/textract-cli/blob/master/LICENSE)\n\nCLI for running files through AWS Textract\n\n## Installation\n\nInstall this tool using `pip`:\n```bash\npip install textract-cli\n```\n## Configuration\n\nAny of the [methods for configuring](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html) `boto3` will work with this tool. Environment variables or a `~/.aws/config` file are good options here.\n\n## Usage\n\nTo run Textract OCR against a JPEG or PNG file (must be smaller than 5MB):\n```bash\ntextract-cli image.jpeg\n```\nThis will output to standard out. To save to a file use this:\n```bash\ntextract-cli image.jpeg > output.txt\n```\nOr use the `-o/--output` option like this:\n```bash\ntextract-cli image.jpeg -o output.txt\n```\n\nFor help, run:\n```bash\ntextract-cli --help\n```\nYou can also use:\n```bash\npython -m textract_cli --help\n```\n## Development\n\nTo contribute to this tool, first checkout the code. Then create a new virtual environment:\n```bash\ncd textract-cli\npython -m venv venv\nsource venv/bin/activate\n```\nNow install the dependencies and test dependencies:\n```bash\npip install -e '.[test]'\n```\nTo run the tests:\n```bash\npytest\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "CLI for running files through AWS Textract",
"version": "0.1",
"project_urls": {
"CI": "https://github.com/simonw/textract-cli/actions",
"Changelog": "https://github.com/simonw/textract-cli/releases",
"Homepage": "https://github.com/simonw/textract-cli",
"Issues": "https://github.com/simonw/textract-cli/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fd746102999fc493cbfcfb944fd1ee4ff54831cfa2c4d672ca7df72359d8bcea",
"md5": "90b1eeae1e65bba72bb3cb9152bb0c74",
"sha256": "ed17add973cf94a43fc95a25ace82fb828747bb2867683cedd2cb9d2469d39e4"
},
"downloads": -1,
"filename": "textract_cli-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90b1eeae1e65bba72bb3cb9152bb0c74",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7318,
"upload_time": "2024-03-29T18:49:11",
"upload_time_iso_8601": "2024-03-29T18:49:11.034082Z",
"url": "https://files.pythonhosted.org/packages/fd/74/6102999fc493cbfcfb944fd1ee4ff54831cfa2c4d672ca7df72359d8bcea/textract_cli-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a05cde8cc5e2c38e41955a9b0185e83d1c38128e176c53b87d23597fcbc4df16",
"md5": "36e9783b54f6a52bf89b995576d76caa",
"sha256": "ef555f6e1e52d63e8efd20e16c2fa950874a3e361a86f248755eccebdf17dffa"
},
"downloads": -1,
"filename": "textract-cli-0.1.tar.gz",
"has_sig": false,
"md5_digest": "36e9783b54f6a52bf89b995576d76caa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6980,
"upload_time": "2024-03-29T18:49:12",
"upload_time_iso_8601": "2024-03-29T18:49:12.584375Z",
"url": "https://files.pythonhosted.org/packages/a0/5c/de8cc5e2c38e41955a9b0185e83d1c38128e176c53b87d23597fcbc4df16/textract-cli-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 18:49:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "simonw",
"github_project": "textract-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "textract-cli"
}
