{
"info": {
"author": "Steve Tautonico",
"author_email": "stautonico@gmail.com",
"bugtrack_url": null,
"classifiers": [],
"description": "\n\n## Unofficial python client for the Docparser API\n\n\n\n#### Table Of Contents\n\n* [Installation](#Installation)\n* [Usage](#Usage)\n* [Contributing](#Contributing)\n* [License](#License)\n* [Changelog](#Changelog)\n* [To-Do](#To-Do)\n* [Documentation](https://github.com/tman540/PyDocParser/blob/master/docs/PyDocParser%20Documentation.md)\n\n
\n\n#### Installation\n\n**__Installation for general usage__**:\n\n**Note:** pydocparser was only tested for python3 (not guaranteed to work for [python2](https://www.jetbrains.com/research/python-developers-survey-2018/))\n\n`pip install pydocparser` or if you have python3 `pip3 install pydocparser`\n\n**OR**\n\nYou can download the release of your choice from [here](https://github.com/tman540/PyDocParser/releases)\n\nUnzip the file\n\nchange directory to the unziped folder\n\nrun `python setup.py install` or `python3 setup.py install`\n\n
\n\n__**Installation for development:**__\n\n`git clone https://github.com/tman540/pydocparser`\n\n`pip install -r requirements.txt`\n\n\n\n#### Usage\n\nTo use pydocparser, you must create an instance of the `Parser` class from the `pydocparser` module:\n\n```python\nimport pydocparser\n\nparser = pydocparser.Parser()\n```\n\nNext, you must obtain your secret API key (which you can get from [here](https://app.docparser.com/myaccount/api))\n\nNow, pydocparser requires this key to be able to access your account. You can do that like this:\n\n```python\nparser.login(YOUR_API_KEY_HERE)\n```\n\nThe docparser API has a function for testing connection to the API\n\n```python3\nresult = parser.ping()\nprint(result)\n# pong\n```\n\nIf `parser.ping()` returns \u2018pong\u2019, then you have a successful connection to the docparser API. If you get an output like this: `Invalid API key. Use Parser.login(api_key)` and you entered your API key, make sure your API key is correct.\n\nYou can get a list of current parsers like this:\n\n```python\nparsers = parser.get_parsers()\n```\n\nThis will return a list of the names of all available parsers.\n\nTo upload a file to docparser, you can use the `upload` function:\n\n```python\nid = parser.upload(\"fileone.pdf\", \"PDF Parser\") #ars: file to upload, the name of the parser\n```\n\nThe function will return the document ID of the file that was just uploaded. To retrieve the parsed data, you can call the `fetch` function:\n\n```python\ndata = parser.fetch(\"PDF Parser\", id) # The id is the doc id that was returned by `parser.upload()`\n```\n\n`fetch` returns all the parsed data from the file you selected\n\n
\n\n#### Contributing\n\nThis project started from the need to use docparser through python at work. I noticed that there was no API library for python, so I decided to make it myself. I am a one man operation so I am glad to accept any help I can get. You can contribute by making your changes, submitting a pull request with a detailed description of what you added. I will review your changes, and if I decide that your changes will make it into the next release, I will credit you accordingly. You can also contribute by submitting bug reports/feature request through GitHub issues.\n\n
\n\n#### License\n\nThis library is available as open source un the [MIT License](https://github.com/tman540/PyDocParser/blob/master/LICENSE.md).\n\n
\n\n#### Changelog\n\nV1.0 (7/11/19) Initial release\n\n[V1.1 (7/12/19) Bug Fixes + New Functions](https://docparser.tautonico.tech/changelog)\n
\n\n#### To-Do\n\n- [ ] Change function names to more closely resemble those in the PHP/Node/AJAX clients\n- [x] Update setup.py to include install requirements\n- [X] Fix README.md to work better on [PyPi](https://pypi.org/project/PyDocParser/)",
"description_content_type": "text/markdown",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/tman540/pydocparser",
"keywords": "docparser,API",
"license": "MIT",
"maintainer": "",
"maintainer_email": "",
"name": "PyDocParser",
"package_url": "https://pypi.org/project/PyDocParser/",
"platform": "",
"project_url": "https://pypi.org/project/PyDocParser/",
"project_urls": {
"Homepage": "https://github.com/tman540/pydocparser"
},
"release_url": "https://pypi.org/project/PyDocParser/1.1.1/",
"requires_dist": null,
"requires_python": "",
"summary": "A python client for the DocParser API",
"version": "1.1.1"
},
"last_serial": 5524479,
"releases": {
"1.0": [
{
"comment_text": "",
"digests": {
"md5": "a02e413dbeb63d026b236d5d4c199a85",
"sha256": "75803a697f08f84b9caca3db8b82463cffbdcabb17c87a12ff6753cf58b48d99"
},
"downloads": -1,
"filename": "PyDocParser-1.0.tar.gz",
"has_sig": false,
"md5_digest": "a02e413dbeb63d026b236d5d4c199a85",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2763,
"upload_time": "2019-07-11T19:13:21",
"url": "https://files.pythonhosted.org/packages/e0/a4/59d6beb510520738721107bb57d27af170ba8eaba03ef2c2d761547aa9b8/PyDocParser-1.0.tar.gz"
}
],
"1.0.1": [
{
"comment_text": "",
"digests": {
"md5": "0cc66cffe0b9e3c5897fdb07e440dccc",
"sha256": "d702a1d6d1449982ef75e6eea81401df8872c115ade4aaed791c4647a40d76e7"
},
"downloads": -1,
"filename": "PyDocParser-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "0cc66cffe0b9e3c5897fdb07e440dccc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2804,
"upload_time": "2019-07-11T19:40:55",
"url": "https://files.pythonhosted.org/packages/51/bc/e41a9e215fd2f48c1e20d51e1c72dc7f48da7b249b18dafbdf29c4e82abe/PyDocParser-1.0.1.tar.gz"
}
],
"1.0.2": [
{
"comment_text": "",
"digests": {
"md5": "5ea978475dd09ae13086f43992bc74bf",
"sha256": "4396d824f546afcf2b4f2a209d902258ed9bf442014451a7e112e790ece44961"
},
"downloads": -1,
"filename": "PyDocParser-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "5ea978475dd09ae13086f43992bc74bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4090,
"upload_time": "2019-07-11T19:44:44",
"url": "https://files.pythonhosted.org/packages/25/a0/81f613d2fa81c1d2c1829b441d1e13f24be45b066799dacf3afe4f102ed2/PyDocParser-1.0.2.tar.gz"
}
],
"1.0.3": [
{
"comment_text": "",
"digests": {
"md5": "483723f535bddaa04ae0c4d99769ebcf",
"sha256": "2bce37681f0143b1ea0441cd99ebe7df752b5a9410ed1d317af5deb1ad1ed443"
},
"downloads": -1,
"filename": "PyDocParser-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "483723f535bddaa04ae0c4d99769ebcf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4154,
"upload_time": "2019-07-11T19:55:10",
"url": "https://files.pythonhosted.org/packages/d6/b2/ebc3fe5711b3c65bf8883659a6a31a92310778256eeaeb7ae9a478178468/PyDocParser-1.0.3.tar.gz"
}
],
"1.1": [
{
"comment_text": "",
"digests": {
"md5": "ced27e5b7625eac94a307dc5c77fe7d9",
"sha256": "3c147bbf12d7f795030cda0fa37cf9d646aebe8d44daf90ba748dcfe09ad1d66"
},
"downloads": -1,
"filename": "PyDocParser-1.1.tar.gz",
"has_sig": false,
"md5_digest": "ced27e5b7625eac94a307dc5c77fe7d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4373,
"upload_time": "2019-07-12T17:49:21",
"url": "https://files.pythonhosted.org/packages/a8/d1/645950d959084cabbbce4d63305ecb07d46b4f1a344f003a0f2944903679/PyDocParser-1.1.tar.gz"
}
],
"1.1.1": [
{
"comment_text": "",
"digests": {
"md5": "ff3e5109db5e0400aa410c62988056a3",
"sha256": "73679a297bb71dbe0dc5276fb0804b2918b133f82b2e949ca7cdd7e48ec7bed7"
},
"downloads": -1,
"filename": "PyDocParser-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ff3e5109db5e0400aa410c62988056a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4397,
"upload_time": "2019-07-12T18:29:47",
"url": "https://files.pythonhosted.org/packages/6f/2f/4d85d9a2ee540808122721e044538f2ed1b95b2c611819ccb3035bd94dda/PyDocParser-1.1.1.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "ff3e5109db5e0400aa410c62988056a3",
"sha256": "73679a297bb71dbe0dc5276fb0804b2918b133f82b2e949ca7cdd7e48ec7bed7"
},
"downloads": -1,
"filename": "PyDocParser-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ff3e5109db5e0400aa410c62988056a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4397,
"upload_time": "2019-07-12T18:29:47",
"url": "https://files.pythonhosted.org/packages/6f/2f/4d85d9a2ee540808122721e044538f2ed1b95b2c611819ccb3035bd94dda/PyDocParser-1.1.1.tar.gz"
}
]
}