oaebu-workflows
Telescopes, Workflows and Data Services for the 'Book Analytics Dashboard Project (2022-2025)', building upon the project 'Developing a Pilot Data Trust for Open Access eBook Usage (2020-2022)'
Science Score: 64.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
2 of 15 committers (13.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.8%) to scientific vocabulary
Keywords
Repository
Telescopes, Workflows and Data Services for the 'Book Analytics Dashboard Project (2022-2025)', building upon the project 'Developing a Pilot Data Trust for Open Access eBook Usage (2020-2022)'
Basic Info
- Host: GitHub
- Owner: The-Academic-Observatory
- License: apache-2.0
- Language: Python
- Default Branch: main
- Homepage: https://documentation.book-analytics.org/
- Size: 17.6 MB
Statistics
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
- Releases: 28
Topics
Metadata Files
README.md
Book Usage Data Workflows
Book Usage Data Workflows provides Apache Airflow workflows for fetching, processing and analysing data about Open Access Books.
Telescope Workflows
A telescope a type of workflow used to ingest data from different data sources, and to run workflows that process and output data to other places. Workflows are built on top of Apache Airflow's DAGs.
The workflows include: Google Analytics, Google Books, JSTOR, IRUS Fulcrum, IRUS OAPEN, Onix, UCL Discovery and an Onix Workflow for combining all of this data.
| Telescope Workflow | Description |
| ------------- | ------------- |
| 
| Crossref Event Data captures discussion on scholarly content and acts as a hub for the storage and distribution of this data. An event may be a citation in a dataset or patent, a mention in a news article, Wikipedia page or on a blog, or discussion and comment on social media. |
| 
| Crossref is a non-for-profit membership organisation working on making scholarly communications better. It is an official Digital Object Identifier (DOI) Registration Agency of the International DOI Foundation. They provide metadata for every DOI that is registered with Crossref. |
| 
| Google Analytics is a web-based service that allows groups to track usage of their web properties. It offers vistor counts, statistics, and other breakdowns such as country or origin for visitors. If publishers or partners already have Google Analytics already setup of their website, this usage data is able to be ingested |
| 
| The Google Books Partner program enables selling books through the Google Play store and offering a preview on Google books. As a publisher it is possible to download reports on Google Books data, currently there are 3 report types available (sales summary, sales transaction and traffic) of which we use the latter 2 |
| 
| IRUS provides COUNTER standard access reports for books hosted on the Fulcrum platform. The reports show access figures for each month and the country of usage |
| 
| IRUS provides COUNTER standard access reports for books hosted on the OAPEN platform. Almost all books on OAPEN are provided as a whole book PDF file. The reports show access figures for each month as well as the location of the access. Since the location info includes an IP-address, the original data is handled only from within the OAPEN Google Cloud project |
| 
| JSTOR provides publisher usage reports, the reports offer details about the use of journal or book content by institution, and country. Journal reports also include usage by issue and article. Usage is aligned with the COUNTER 5 standard of Item Requests (views + downloads) |
| 
| The OAPEN Library hosts more than 18,000 Open Access books. OAPEN enables libraries and aggregators to use the metadata of all available titles in the OAPEN Library, made available under a CC0 1.0 license. The metadata is available in different formats and the OAPEN metadata telescope harvests the data in XML format |
| 
| ONIX is a standard format that book publishers use to share information about the books that they have published. Publishers that have ONIX feeds are given credentials and access to their own upload folder on the Mellon SFTP server. The publisher uploads their ONIX feed to their upload folder on a weekly, fortnightly or monthly basis. The ONIX telescope downloads, transforms (with the ONIX parser Java command line tool) and then loads the ONIX data into BigQuery for further processing |
| 
| Thoth is a free, open metadata service that publishers can choose to utilise as a solution for metadata storage. Thoth can provide metadata upon request in a number of formats. The Thoth telescope uses the Thoth Export API to download metadata in an ONIX format. |
| 
| UCL Discovery is UCL's open access repository, showcasing and providing access to the full texts of UCL research publications.The metadata for all eprints is obtained from their publicly available CSV file (https://discovery.ucl.ac.uk/cgi/search/advanced) |
Documentation
For detailed documentation about the Book Usage Data Workflows hosted on GitBook, click here. Thank you to GitBook for the supporting this repository under their Open Source plan.
Other requirements to create the Book Usage Datasets
The Observatory Platform, an environment for fetching, processing and analysing data, see the Repository https://github.com/The-Academic-Observatory/observatory-platform
The Academic Observatory Workflows, which provides Apache Airflow workflows for fetching, processing and analysing data about academic institutions, see the Repository https://github.com/The-Academic-Observatory/academic-observatory-workflows
The Onix Parser, a command line tool that transforms ONIX files into a format suitable for loading into BigQuery, see the Repository https://github.com/The-Academic-Observatory/onix-parser
Owner
- Name: The Academic Observatory
- Login: The-Academic-Observatory
- Kind: organization
- Repositories: 14
- Profile: https://github.com/The-Academic-Observatory
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
title: "Book Usage Data Workflows"
url: "https://github.com/The-Academic-Observatory/oaebu-workflows"
doi: 10.5281/zenodo.6366690
authors:
- given-names: "Keegan R"
family-names: "Smith"
- given-names: "Richard"
family-names: "Hosking"
- given-names: "Aniek"
family-names: "Roelofs"
- given-names: "Tuan-Yow"
family-names: "Chien"
- given-names: "James P"
family-names: "Diprose"
- given-names: "Rebecca N"
family-names: "Handcock"
- given-names: "Alex"
family-names: "Massen-Hane"
- given-names: "Alkim"
family-names: "Ozaygen"
- given-names: "Kathryn R"
family-names: "Napier"
- given-names: "Laura J"
family-names: "Wilkinson"
- given-names: "Cameron"
family-names: "Neylon"
- given-names: "Lucy"
family-names: "Montgomery"
GitHub Events
Total
- Create event: 21
- Release event: 7
- Watch event: 1
- Delete event: 14
- Member event: 1
- Issue comment event: 9
- Push event: 20
- Pull request review comment event: 14
- Pull request review event: 8
- Pull request event: 17
- Fork event: 1
Last Year
- Create event: 21
- Release event: 7
- Watch event: 1
- Delete event: 14
- Member event: 1
- Issue comment event: 9
- Push event: 20
- Pull request review comment event: 14
- Pull request review event: 8
- Pull request event: 17
- Fork event: 1
Committers
Last synced: almost 3 years ago
All Time
- Total Commits: 308
- Total Committers: 15
- Avg Commits per committer: 20.533
- Development Distribution Score (DDS): 0.698
Top Committers
| Name | Commits | |
|---|---|---|
| Jamie Diprose | j****e@g****m | 93 |
| aroelo | a****s@c****u | 71 |
| Keegan Smith | 3****1@u****m | 30 |
| tuanchien | t****n@u****m | 29 |
| Richard Hosking | r****d@h****m | 22 |
| Bec Handcock | 4****k@u****m | 19 |
| Bec Handcock | 4****k@u****m | 10 |
| Richard Hosking | r****g@c****u | 9 |
| niamhq | 9****q@u****m | 8 |
| Cameron Neylon | cn@c****t | 5 |
| kathrynnapier | 4****r@u****m | 4 |
| Alex Massen-Hane | 1****e@u****m | 3 |
| aroelo | a****3@l****l | 3 |
| Samuel Klein | m****j@g****m | 1 |
| Jamie Diprose | 5****g@u****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 2
- Total pull requests: 221
- Average time to close issues: about 3 years
- Average time to close pull requests: 15 days
- Total issue authors: 1
- Total pull request authors: 9
- Average comments per issue: 2.5
- Average comments per pull request: 1.0
- Merged pull requests: 205
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 18
- Average time to close issues: N/A
- Average time to close pull requests: 20 days
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.94
- Merged pull requests: 17
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- aroelo (2)
- jdddog (1)
Pull Request Authors
- keegansmith21 (166)
- jdddog (34)
- kathrynnapier (16)
- aroelo (9)
- niamhq (9)
- tuanchien (8)
- alexmassen-hane (5)
- rhosking (4)
- bechandcock (3)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 11 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 4
- Total maintainers: 1
pypi.org: oaebu-workflows
Oaebu Workflows provides Apache Airflow Workflows for fetching, processing and analysing data about open access books.
- Homepage: https://github.com/The-Academic-Observatory/oaebu-workflows
- Documentation: https://oaebu-workflows.readthedocs.io/en/latest/
- License: Apache License Version 2.0
-
Latest release: 2023.12.0
published about 2 years ago
Rankings
Maintainers (1)
Dependencies
- Sphinx >3
- pandas *
- pbr ==5.5.
- recommonmark ==0.7.
- sphinx-autoapi ==1.8.
- sphinx-rtd-theme ==0.5.
- Markdown ==3.3.4
- beautifulsoup4 >=4.9.3,<5
- faker >=8.12.1,<9
- responses ==0.20.
- actions/checkout v2 composite
- actions/setup-python v2 composite
- pypa/gh-action-pypi-publish master composite
- actions/checkout v2 composite
- actions/setup-java v2 composite
- actions/setup-python v2 composite
- codecov/codecov-action v1 composite