# Welcome to astrotree!
A lightweight, purely python package to handle reference trees.
This project evolved because of a personal urge to organize literature from my day-to-day.
Note that this is not a reference manager: if you are looking for a python-based reference manager, look no further than [Papis](https://pypi.org/project/papis/)!
This project helps you connect literature entries: given an article, you can choose to build a tree of other articles that connect to it. These are articles referenced in the article of interest (references), or works that cited it (citations). Trees can be built to arbitrary depths, limited only by resources available to python and records on the internet, at any level of the tree.
The project presently uses the NASA-ADS API (see [ADS Docs](https://ui.adsabs.harvard.edu/help/api/api-docs.html#servers)) to launch queries and is suited to my use case; any efforts to contribute and extend it to other APIs are welcome!
# Installation
Install directly through pip:
pip install astrotree
# Prerequisite
Before you can start to use this application, you need to set an environment variable `ADSTOKEN`, which needs to point to your ADS API token.
Follow the instructions [here](https://ui.adsabs.harvard.edu/help/api/) to obtain your ADS API token.
You are subject to the [ADS API Terms of Service](https://ui.adsabs.harvard.edu/help/terms/) through your use of this application.
# Usage
The application is CLI-based and has two modes: you may choose to build either a reference tree or a citation tree.
To build a reference tree, use:
astrotree -id <ADS id> --ref
To build a citation tree, use:
astrotree -id <ADS id> --cite
In either case the output is a list of ADS IDs and the respective article titles, in a tree format. The tool offers you the opportunity to ask to build a tree for any of the listed IDs, restricted to the same mode you started with.
Upon exit (press n when the application asks if you wish to continue), the tree is dumped to a text file containing the tree in the local directory, for future use.
Raw data
{
"_id": null,
"home_page": "https://github.com/arka378/astrotree",
"name": "astrotree",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7, <4",
"maintainer_email": "",
"keywords": "academic,references,development",
"author": "Arka Ghosh",
"author_email": "arka378@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2e/a5/73cc0d750f81cfd1cc7e4840c67f1e0e7b36831db8577c5548da32f370aa/astrotree-1.1.5.tar.gz",
"platform": null,
"description": "# Welcome to astrotree!\n\nA lightweight, purely python package to handle reference trees.\nThis project evolved because of a personal urge to organize literature from my day-to-day.\nNote that this is not a reference manager: if you are looking for a python-based reference manager, look no further than [Papis](https://pypi.org/project/papis/)!\n\nThis project helps you connect literature entries: given an article, you can choose to build a tree of other articles that connect to it. These are articles referenced in the article of interest (references), or works that cited it (citations). Trees can be built to arbitrary depths, limited only by resources available to python and records on the internet, at any level of the tree.\n\nThe project presently uses the NASA-ADS API (see [ADS Docs](https://ui.adsabs.harvard.edu/help/api/api-docs.html#servers)) to launch queries and is suited to my use case; any efforts to contribute and extend it to other APIs are welcome!\n\n# Installation\n\nInstall directly through pip:\n\n pip install astrotree\n\n# Prerequisite\n\nBefore you can start to use this application, you need to set an environment variable `ADSTOKEN`, which needs to point to your ADS API token.\nFollow the instructions [here](https://ui.adsabs.harvard.edu/help/api/) to obtain your ADS API token.\nYou are subject to the [ADS API Terms of Service](https://ui.adsabs.harvard.edu/help/terms/) through your use of this application.\n\n# Usage\nThe application is CLI-based and has two modes: you may choose to build either a reference tree or a citation tree.\nTo build a reference tree, use:\n\n astrotree -id <ADS id> --ref \n\nTo build a citation tree, use:\n\n astrotree -id <ADS id> --cite\n\n\nIn either case the output is a list of ADS IDs and the respective article titles, in a tree format. The tool offers you the opportunity to ask to build a tree for any of the listed IDs, restricted to the same mode you started with.\n\nUpon exit (press n when the application asks if you wish to continue), the tree is dumped to a text file containing the tree in the local directory, for future use.\n\n\n\n \n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "ADS-powered reference tree-builder for the Astro community!",
"version": "1.1.5",
"split_keywords": [
"academic",
"references",
"development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8369fb036f49b52dbdad744ca08ed6ad469fb2ac673c8a07f6ae2ed59da6c746",
"md5": "ea3254eff9438e85e1f5e267e4c426d8",
"sha256": "8a91f01c0f053428a2f8000122b6c1f10a9595783c3ff31ee7bab7ce94aa3cfd"
},
"downloads": -1,
"filename": "astrotree-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea3254eff9438e85e1f5e267e4c426d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7, <4",
"size": 5936,
"upload_time": "2023-04-27T21:08:54",
"upload_time_iso_8601": "2023-04-27T21:08:54.844141Z",
"url": "https://files.pythonhosted.org/packages/83/69/fb036f49b52dbdad744ca08ed6ad469fb2ac673c8a07f6ae2ed59da6c746/astrotree-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ea573cc0d750f81cfd1cc7e4840c67f1e0e7b36831db8577c5548da32f370aa",
"md5": "36d28526df5199d9cee77472ac18b0b3",
"sha256": "b3a5f41e62a009ec8ed52e1a0b55a67532cda16d530402121dde307c71d1f5b2"
},
"downloads": -1,
"filename": "astrotree-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "36d28526df5199d9cee77472ac18b0b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7, <4",
"size": 8521,
"upload_time": "2023-04-27T21:08:56",
"upload_time_iso_8601": "2023-04-27T21:08:56.986762Z",
"url": "https://files.pythonhosted.org/packages/2e/a5/73cc0d750f81cfd1cc7e4840c67f1e0e7b36831db8577c5548da32f370aa/astrotree-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-27 21:08:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "arka378",
"github_project": "astrotree",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "astrotree"
}
JSON
