| Name | voy JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | A CLI for following arXiv authors. |
| upload_time | 2024-09-19 10:04:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12.0 |
| license | MIT License Copyright (c) 2024 Florin Gogianu 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 |
arxiv
feed
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# voy
A CLI for following arxiv authors.
## Installation
Configure an environment with `python 3.12` and run the command:
```sh
pip install git+https://github.com/floringogianu/voy.git
```
I used some experimental syntax that's only in `3.11` and above and I haven't aimed at backward compatibility yet.
## Usage
Start with `voy --help`. A general flow would be:
- `voy search [FirstName] LastName`: queries arxiv and returns a list of authors and their papers matching the name
- `voy follow [FirstName] LastName`: follow the author so that their new papers show up when calling `voy show`
- `voy update`: after each `voy follow` and then daily. It updates the database with the most recent papers by the authors you follow.
In addition it commits to the database every co-author on these papers.
This makes it easy to search for authors in your database, using `voy show Some Researcher`.
- `voy show` / `voy show [FirstName] LastName`: **probably the command you will use most often**. It lists the most recent papers of
the people you follow or of a specific author. Check `voy show --help` for the many options of this command.
- `voy triage`: quickly review the papers in your feed.
### Getting started
https://github.com/floringogianu/voy/assets/1670348/65a6bc6f-e813-4516-a321-76774b4f4cf7
### Triage
Let's say you have a large number of researchers you follow and you want to quickly review and triage papers so that they don't show anymore in the `voy show` feed.
You can achieve this with `voy triage`.
https://github.com/floringogianu/voy/assets/1670348/6457b97f-980e-4c7d-b5f5-2f03e288554d
Raw data
{
"_id": null,
"home_page": null,
"name": "voy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12.0",
"maintainer_email": null,
"keywords": "arxiv, feed",
"author": null,
"author_email": "Florin Gogianu <florin.gogianu@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d2/5e/f5bfe7e2c00a1ca69da298f060e9f93db378721ca2caffa802471fea7cd7/voy-0.0.2.tar.gz",
"platform": null,
"description": "# voy\n\nA CLI for following arxiv authors.\n\n## Installation\n\nConfigure an environment with `python 3.12` and run the command:\n\n```sh\npip install git+https://github.com/floringogianu/voy.git\n```\n\nI used some experimental syntax that's only in `3.11` and above and I haven't aimed at backward compatibility yet.\n\n## Usage\n\nStart with `voy --help`. A general flow would be:\n- `voy search [FirstName] LastName`: queries arxiv and returns a list of authors and their papers matching the name\n- `voy follow [FirstName] LastName`: follow the author so that their new papers show up when calling `voy show`\n- `voy update`: after each `voy follow` and then daily. It updates the database with the most recent papers by the authors you follow.\nIn addition it commits to the database every co-author on these papers.\nThis makes it easy to search for authors in your database, using `voy show Some Researcher`.\n- `voy show` / `voy show [FirstName] LastName`: **probably the command you will use most often**. It lists the most recent papers of\nthe people you follow or of a specific author. Check `voy show --help` for the many options of this command.\n- `voy triage`: quickly review the papers in your feed.\n\n### Getting started\n\nhttps://github.com/floringogianu/voy/assets/1670348/65a6bc6f-e813-4516-a321-76774b4f4cf7\n\n### Triage\n\nLet's say you have a large number of researchers you follow and you want to quickly review and triage papers so that they don't show anymore in the `voy show` feed.\nYou can achieve this with `voy triage`.\n\nhttps://github.com/floringogianu/voy/assets/1670348/6457b97f-980e-4c7d-b5f5-2f03e288554d\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Florin Gogianu 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": "A CLI for following arXiv authors.",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/floringogianu/voy"
},
"split_keywords": [
"arxiv",
" feed"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "abe6dad929aa189b4154b825f73a53dbc9acc911135e95884f0a264b77f47b1a",
"md5": "5e9f60196f6cc46c7e3e439c73cace77",
"sha256": "a35c8d1f7498da66aa8457277b30b8df6c9dbecfb1afb15b720ce8c582d1af2a"
},
"downloads": -1,
"filename": "voy-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e9f60196f6cc46c7e3e439c73cace77",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12.0",
"size": 25585,
"upload_time": "2024-09-19T10:04:04",
"upload_time_iso_8601": "2024-09-19T10:04:04.386555Z",
"url": "https://files.pythonhosted.org/packages/ab/e6/dad929aa189b4154b825f73a53dbc9acc911135e95884f0a264b77f47b1a/voy-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d25ef5bfe7e2c00a1ca69da298f060e9f93db378721ca2caffa802471fea7cd7",
"md5": "0c183f9507af5eb28428827186ab4a27",
"sha256": "a91817d4392f24c5c71a607e494f4d440c2ecc82a6d49e9b8bf3b9eba7df8be6"
},
"downloads": -1,
"filename": "voy-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "0c183f9507af5eb28428827186ab4a27",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12.0",
"size": 22752,
"upload_time": "2024-09-19T10:04:06",
"upload_time_iso_8601": "2024-09-19T10:04:06.094784Z",
"url": "https://files.pythonhosted.org/packages/d2/5e/f5bfe7e2c00a1ca69da298f060e9f93db378721ca2caffa802471fea7cd7/voy-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-19 10:04:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "floringogianu",
"github_project": "voy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "voy"
}
