| Name | talk-to-a-file JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | Simple CLI to talk to a file |
| upload_time | 2024-08-06 01:32:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 deven367 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
anthropic
pypdf
click
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# talk-to-a-file
This is a very simple utility script that I just created so that you could send the content of a pdf to an LLM and talk to it.
## instructions
To install the app, you just need to do,
```sh
pip install git+https://github.com/deven367/talk-to-a-file
```
or
```sh
git clone https://github.com/deven367/talk-to-a-file
cd talk-to-a-file
pip install -e .
```
> [!NOTE]
> The package will be uploaded on `pypi` soon.
### prerequisites
To use this package, you need to use your own `ANTHROPIC_API_KEY`. Before using the CLI command, you need to set the environment variable. To do so,
```sh
export ANTHROPIC_API_KEY=<your-api-key>
```
## how it works
Once the package is installed, you can use the CLI command, `talk-to-a-file`,
The CLI has a required argument, `pdf`, which is the path to the pdf file that you want to read.
Here is a small example, where I talk to the pdf file, `docs/tcm.pdf`,
To quit the CLI, you can type `exit` or `quit`.
## how to contribute
Issues and PRs are welcome. If you have any suggestions or improvements, feel free to open an issue or a PR.
Raw data
{
"_id": null,
"home_page": null,
"name": "talk-to-a-file",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "anthropic, pypdf, click",
"author": null,
"author_email": "Deven Mistry <masterdeven@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d8/59/cba1725e44259db3b8f1181e9fc9b74cd3ab34ed6b3e516f0c8c8b59a174/talk_to_a_file-0.0.1.tar.gz",
"platform": null,
"description": "# talk-to-a-file\n\nThis is a very simple utility script that I just created so that you could send the content of a pdf to an LLM and talk to it.\n\n## instructions\n\nTo install the app, you just need to do,\n\n```sh\npip install git+https://github.com/deven367/talk-to-a-file\n```\n\nor\n\n```sh\ngit clone https://github.com/deven367/talk-to-a-file\ncd talk-to-a-file\npip install -e .\n```\n\n> [!NOTE]\n> The package will be uploaded on `pypi` soon.\n\n### prerequisites\n\nTo use this package, you need to use your own `ANTHROPIC_API_KEY`. Before using the CLI command, you need to set the environment variable. To do so,\n\n```sh\nexport ANTHROPIC_API_KEY=<your-api-key>\n```\n\n## how it works\n\nOnce the package is installed, you can use the CLI command, `talk-to-a-file`,\n\nThe CLI has a required argument, `pdf`, which is the path to the pdf file that you want to read.\n\n\n\nHere is a small example, where I talk to the pdf file, `docs/tcm.pdf`,\n\n\n\nTo quit the CLI, you can type `exit` or `quit`.\n\n## how to contribute\n\nIssues and PRs are welcome. If you have any suggestions or improvements, feel free to open an issue or a PR.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 deven367 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Simple CLI to talk to a file",
"version": "0.0.1",
"project_urls": null,
"split_keywords": [
"anthropic",
" pypdf",
" click"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "03b126726605d0d315067a72f3e733775c0e2674bd1d958dbb8b426dee26b278",
"md5": "7364917f4bb21d4b7b877d003c6df709",
"sha256": "5056c8e8b5de4eb1f3fecda24d9be4eb3b77343aab3862bd8c29fe565c638999"
},
"downloads": -1,
"filename": "talk_to_a_file-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7364917f4bb21d4b7b877d003c6df709",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5444,
"upload_time": "2024-08-06T01:32:19",
"upload_time_iso_8601": "2024-08-06T01:32:19.879226Z",
"url": "https://files.pythonhosted.org/packages/03/b1/26726605d0d315067a72f3e733775c0e2674bd1d958dbb8b426dee26b278/talk_to_a_file-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d859cba1725e44259db3b8f1181e9fc9b74cd3ab34ed6b3e516f0c8c8b59a174",
"md5": "a5114eb00d04a229740e842b64e89fd1",
"sha256": "10b50173eccc8d23d8c49365a97015b08b068433f53e081b47f6d2590a929cb8"
},
"downloads": -1,
"filename": "talk_to_a_file-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "a5114eb00d04a229740e842b64e89fd1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4129,
"upload_time": "2024-08-06T01:32:21",
"upload_time_iso_8601": "2024-08-06T01:32:21.664657Z",
"url": "https://files.pythonhosted.org/packages/d8/59/cba1725e44259db3b8f1181e9fc9b74cd3ab34ed6b3e516f0c8c8b59a174/talk_to_a_file-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-06 01:32:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "talk-to-a-file"
}
