# CloudsOfArx
[](https://codecov.io/gh/James11222/CloudsOfArx)
An automated webscraper package to make wordcloud images out of the abstracts of your first-author papers.
## Installation
To use this package just install via pip
`pip install CloudsOfArx`
## Usage
This package is simple and straightforward. To use it simply run the following lines in your python environment of choice after installation via pip.
``` python
import CloudsOfArx
CloudsOfArx.create_wordcloud(ADS_TOKEN, author, image_file, orcid=None, save_name=None)
```
The `ADS_TOKEN` is required to use the NASA ADS API. Make an account on NASA ADS to acquire an API token key, then copy and paste the key as a string for that argument. The `author` argument is the name of the first-author in a "LastName, FirstName" formatted string. `image_file` is a string pointing to the desired image for masking the wordcloud into. I also include the optional `orcid` parameter for authors who wish to use their ORCID to ensure the papers used are their own work. The `save_name` argument is an optional argument for naming the saved wordcloud file.
An example of this is shown below
Raw data
{
"_id": null,
"home_page": "https://github.com/James11222/CloudsOfArx/",
"name": "CloudsOfArx",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6, <4",
"maintainer_email": "",
"keywords": "ArXiv,ADS,wordcloud",
"author": "James Sunseri",
"author_email": "jamessunseri@berkeley.edu",
"download_url": "https://files.pythonhosted.org/packages/e1/78/8f32db1a060a27ab1b8a84a4a39dd8c606c0f6ffd8356dc03e0d11b08e9b/CloudsOfArx-0.4.0.tar.gz",
"platform": "any",
"description": "# CloudsOfArx \n[](https://codecov.io/gh/James11222/CloudsOfArx)\n\n\n\nAn automated webscraper package to make wordcloud images out of the abstracts of your first-author papers. \n\n## Installation\n\nTo use this package just install via pip\n\n`pip install CloudsOfArx`\n\n## Usage\n\nThis package is simple and straightforward. To use it simply run the following lines in your python environment of choice after installation via pip.\n\n``` python\nimport CloudsOfArx\n\nCloudsOfArx.create_wordcloud(ADS_TOKEN, author, image_file, orcid=None, save_name=None)\n```\n\nThe `ADS_TOKEN` is required to use the NASA ADS API. Make an account on NASA ADS to acquire an API token key, then copy and paste the key as a string for that argument. The `author` argument is the name of the first-author in a \"LastName, FirstName\" formatted string. `image_file` is a string pointing to the desired image for masking the wordcloud into. I also include the optional `orcid` parameter for authors who wish to use their ORCID to ensure the papers used are their own work. The `save_name` argument is an optional argument for naming the saved wordcloud file.\n\nAn example of this is shown below\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Web Scraper package for generating wordclouds from research paper abstracts.",
"version": "0.4.0",
"split_keywords": [
"arxiv",
"ads",
"wordcloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e1788f32db1a060a27ab1b8a84a4a39dd8c606c0f6ffd8356dc03e0d11b08e9b",
"md5": "3d26edf5f9ad241a343d62b715668ce4",
"sha256": "5814f48f1f7df8baebd937e06bef964248f993413344698b4265400d715110e4"
},
"downloads": -1,
"filename": "CloudsOfArx-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "3d26edf5f9ad241a343d62b715668ce4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6, <4",
"size": 6253,
"upload_time": "2023-01-06T15:51:03",
"upload_time_iso_8601": "2023-01-06T15:51:03.013895Z",
"url": "https://files.pythonhosted.org/packages/e1/78/8f32db1a060a27ab1b8a84a4a39dd8c606c0f6ffd8356dc03e0d11b08e9b/CloudsOfArx-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-06 15:51:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "James11222",
"github_project": "CloudsOfArx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "cloudsofarx"
}
JSON
