Document AI Toolbox
=================================
|experimental| |versions|
`Document AI Toolbox`_: Document AI Toolbox aims to reduce the friction of managing, manipulating, and extracting information from outputs of Document AI ``BatchProcessDocuments()`` (JSON files written to user-managed GCS buckets) and ``ProcessDocument()`` methods, programmatically.
**Disclaimer**
The Document AI Toolbox is in an experimental state. This library is a work-in-progress and is likely to have backwards-incompatible changes. Users of the toolbox might need to rewrite their code when upgrading the toolbox version.
.. |experimental| image:: https://img.shields.io/badge/support-experimental-red.svg
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-documentai-toolbox.svg
:target: https://pypi.org/project/google-cloud-documentai-toolbox/
Quick Start
-----------
In order to use this library, you first need to go through the following steps:
Enabling Document AI may not be technically required to use this library, unless ``ProcessDocument()`` is intended to be used.
But you must enable the Storage API to access GCS buckets that contains the output of ``BatchProcessDocument()``.
You will need to enable the BigQuery API if you intend to use the BigQuery features.
1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. `Enable the Storage API.`_
4. `Enable the Document AI API.`_
5. `Enable the BigQuery API.`_
6. `Setup Authentication.`_
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Storage API.: https://cloud.google.com/storage/docs
.. _Enable the Document AI API.: https://cloud.google.com/document-ai/docs
.. _Enable the BigQuery API.: https://cloud.google.com/bigquery/docs
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
Installation
~~~~~~~~~~~~
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
create isolated Python environments. The basic problem it addresses is one of
dependencies and versions, and indirectly permissions.
With `virtualenv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
Code samples and snippets
~~~~~~~~~~~~~~~~~~~~~~~~~
Code samples and snippets live in the `samples/` folder.
Supported Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^
Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
Python.
Python >= 3.8
.. _active: https://devguide.python.org/devcycle/#in-development-main-branch
.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
**NOTE**:
Python 3.7 was marked as `unsupported`_ by the python community in June 2023.
We recommend that all developers upgrade to Python 3.8 and newer as soon as
they can. Support for Python 3.7 will be removed from all client libraries after
January 1 2024. Client libraries that support Python 3.7 will continue to be available
for download, but releases after January 1 2024 will only target Python 3.8 and
newer.
.. _unsupported: https://devguide.python.org/versions/#unsupported-versions
Unsupported Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Python <= 3.6
If you are using an `end-of-life`_
version of Python, we recommend that you update as soon as possible to an actively supported version.
.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches
Mac/Linux
^^^^^^^^^
.. code-block:: console
pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-documentai-toolbox
Windows
^^^^^^^
.. code-block:: console
pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-documentai-toolbox
Next Steps
~~~~~~~~~~
- Read the `Document AI product documentation`_ to learn
more about the product and see How-to Guides.
- Read the `Client Library Documentation`_ for Document AI Toolbox
to see other available methods on the client.
- View this `README`_ to see the full list of Cloud
APIs that we cover.
.. _`Client Library Documentation`: https://cloud.google.com/python/docs/reference/documentai-toolbox/latest
.. _`Document AI documentation`: https://cloud.google.com/document-ai
.. _`Document AI product documentation`: https://cloud.google.com/document-ai/docs/overview
.. _`README`: https://github.com/googleapis/python-documentai-toolbox/blob/main/README.rst
Raw data
{
"_id": null,
"home_page": "https://github.com/googleapis/python-documentai-toolbox",
"name": "google-cloud-documentai-toolbox",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Google LLC",
"author_email": "googleapis-packages@google.com",
"download_url": "https://files.pythonhosted.org/packages/1c/5f/11713b0ec2909d5560656b01a3dc99c29dff5356871e4c3678d543deb3b7/google-cloud-documentai-toolbox-0.13.3a0.tar.gz",
"platform": "Posix; MacOS X; Windows",
"description": "Document AI Toolbox\n=================================\n\n|experimental| |versions|\n\n`Document AI Toolbox`_: Document AI Toolbox aims to reduce the friction of managing, manipulating, and extracting information from outputs of Document AI ``BatchProcessDocuments()`` (JSON files written to user-managed GCS buckets) and ``ProcessDocument()`` methods, programmatically.\n\n**Disclaimer**\n\nThe Document AI Toolbox is in an experimental state. This library is a work-in-progress and is likely to have backwards-incompatible changes. Users of the toolbox might need to rewrite their code when upgrading the toolbox version.\n\n.. |experimental| image:: https://img.shields.io/badge/support-experimental-red.svg\n :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels\n.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-documentai-toolbox.svg\n :target: https://pypi.org/project/google-cloud-documentai-toolbox/\n\n\nQuick Start\n-----------\n\nIn order to use this library, you first need to go through the following steps:\n\nEnabling Document AI may not be technically required to use this library, unless ``ProcessDocument()`` is intended to be used.\nBut you must enable the Storage API to access GCS buckets that contains the output of ``BatchProcessDocument()``. \nYou will need to enable the BigQuery API if you intend to use the BigQuery features.\n\n1. `Select or create a Cloud Platform project.`_\n2. `Enable billing for your project.`_\n3. `Enable the Storage API.`_\n4. `Enable the Document AI API.`_\n5. `Enable the BigQuery API.`_\n6. `Setup Authentication.`_\n\n.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project\n.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project\n.. _Enable the Storage API.: https://cloud.google.com/storage/docs\n.. _Enable the Document AI API.: https://cloud.google.com/document-ai/docs\n.. _Enable the BigQuery API.: https://cloud.google.com/bigquery/docs\n.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html\n\nInstallation\n~~~~~~~~~~~~\n\nInstall this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to\ncreate isolated Python environments. The basic problem it addresses is one of\ndependencies and versions, and indirectly permissions.\n\nWith `virtualenv`_, it's possible to install this library without needing system\ninstall permissions, and without clashing with the installed system\ndependencies.\n\n.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/\n\n\nCode samples and snippets\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nCode samples and snippets live in the `samples/` folder.\n\n\nSupported Python Versions\n^^^^^^^^^^^^^^^^^^^^^^^^^\nOur client libraries are compatible with all current `active`_ and `maintenance`_ versions of\nPython.\n\nPython >= 3.8\n\n.. _active: https://devguide.python.org/devcycle/#in-development-main-branch\n.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches\n\n**NOTE**:\nPython 3.7 was marked as `unsupported`_ by the python community in June 2023.\nWe recommend that all developers upgrade to Python 3.8 and newer as soon as\nthey can. Support for Python 3.7 will be removed from all client libraries after\nJanuary 1 2024. Client libraries that support Python 3.7 will continue to be available\nfor download, but releases after January 1 2024 will only target Python 3.8 and\nnewer.\n\n.. _unsupported: https://devguide.python.org/versions/#unsupported-versions\n\nUnsupported Python Versions\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\nPython <= 3.6\n\nIf you are using an `end-of-life`_\nversion of Python, we recommend that you update as soon as possible to an actively supported version.\n\n.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches\n\nMac/Linux\n^^^^^^^^^\n\n.. code-block:: console\n\n pip install virtualenv\n virtualenv <your-env>\n source <your-env>/bin/activate\n <your-env>/bin/pip install google-cloud-documentai-toolbox\n\n\nWindows\n^^^^^^^\n\n.. code-block:: console\n\n pip install virtualenv\n virtualenv <your-env>\n <your-env>\\Scripts\\activate\n <your-env>\\Scripts\\pip.exe install google-cloud-documentai-toolbox\n\nNext Steps\n~~~~~~~~~~\n\n- Read the `Document AI product documentation`_ to learn\n more about the product and see How-to Guides.\n- Read the `Client Library Documentation`_ for Document AI Toolbox\n to see other available methods on the client.\n- View this `README`_ to see the full list of Cloud\n APIs that we cover.\n\n.. _`Client Library Documentation`: https://cloud.google.com/python/docs/reference/documentai-toolbox/latest\n.. _`Document AI documentation`: https://cloud.google.com/document-ai\n.. _`Document AI product documentation`: https://cloud.google.com/document-ai/docs/overview\n.. _`README`: https://github.com/googleapis/python-documentai-toolbox/blob/main/README.rst\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "",
"version": "0.13.3a0",
"project_urls": {
"Homepage": "https://github.com/googleapis/python-documentai-toolbox"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f24ccdc9c86567f47a65a239cb83ad2941ec8d6f1126b898e2d32b70854c0a0f",
"md5": "1fff5c99d679f976e860c95cb98d0538",
"sha256": "66d1d889172fc6036af7b4e9b4483365af4403c45c9333efc51dea4e81967383"
},
"downloads": -1,
"filename": "google_cloud_documentai_toolbox-0.13.3a0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1fff5c99d679f976e860c95cb98d0538",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 42801,
"upload_time": "2024-03-11T17:53:43",
"upload_time_iso_8601": "2024-03-11T17:53:43.980653Z",
"url": "https://files.pythonhosted.org/packages/f2/4c/cdc9c86567f47a65a239cb83ad2941ec8d6f1126b898e2d32b70854c0a0f/google_cloud_documentai_toolbox-0.13.3a0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1c5f11713b0ec2909d5560656b01a3dc99c29dff5356871e4c3678d543deb3b7",
"md5": "1ac1358a92036f06ba713c28ccc39841",
"sha256": "ba4f2c9dd3cbc3a742c5a91ddbd11ed0511dae66009fefe5c7f3fa2323c54745"
},
"downloads": -1,
"filename": "google-cloud-documentai-toolbox-0.13.3a0.tar.gz",
"has_sig": false,
"md5_digest": "1ac1358a92036f06ba713c28ccc39841",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 24300437,
"upload_time": "2024-03-11T17:53:47",
"upload_time_iso_8601": "2024-03-11T17:53:47.288734Z",
"url": "https://files.pythonhosted.org/packages/1c/5f/11713b0ec2909d5560656b01a3dc99c29dff5356871e4c3678d543deb3b7/google-cloud-documentai-toolbox-0.13.3a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-11 17:53:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "googleapis",
"github_project": "python-documentai-toolbox",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "google-cloud-documentai-toolbox"
}
JSON
