https://github.com/centerforopenscience/pyimpactstory
Python library for ImpactStory
https://github.com/centerforopenscience/pyimpactstory
Last synced: 5 months ago
JSON representation
Python library for ImpactStory
- Host: GitHub
- URL: https://github.com/centerforopenscience/pyimpactstory
- Owner: CenterForOpenScience
- License: other
- Created: 2014-06-30T13:44:04.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-07-11T15:54:56.000Z (over 11 years ago)
- Last Synced: 2025-07-10T21:28:03.230Z (7 months ago)
- Language: Python
- Homepage:
- Size: 890 KB
- Stars: 3
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- License: LICENSE.txt
Awesome Lists containing this project
README
=============
PyImpactStory
=============
Python library for ImpactStory. This tool parses the provided JSON file for a given Impactstory user in order to extract
bibliographic information and metric data for each of their professional "Products". ImpactStory defines a "Product"
as any one article, dataset, figure, slideshow, software, video, webpage, or "unknown" (product with genre not
previously listed) that a user has produced throughout their career and added to their ImpactStory profile. As
previously stated, this library enables the extraction of these "products" and their bibliographic and
metric information.
To access product information for an Impactstory user:
from PyImpactStory.impact_story.impact_story import ImpactStory
Create an ImpactStory object from either the JSON file or directly from the user's url extension::
username = ImpactStory.from_file(file.json)
username = ImpactStory.from_id("HeatherPiwowar")
Products are sorted into lists based on product type. Thus, to access product and product information by type:
article_list = user.articles
article = article_list[0]
To access specific bibliographic information for any given product such as its title, published date or author:
article.title
article.published_date
article.authors
To access metric information for any given product, such as its audience or engagement type (e.g. number of views):
metric_list = article.metrics
metric = metric_list[0]
metric.audience
metric.engagement_type