Whether you're launching a new project or maintaining an existing one, the Metadata Extractor for FAIRsoft automates the extraction of critical metadata from your repositories. This process can be initiated through the FAIRsoft Evaluator, a user-friendly web application that also lets you edit and assess your software's alignment with the FAIR principles. For those who prefer automated workflows or integrations, API access is available for additional flexibility. These tools make it easy to enhance the visibility, accessibility, and reusability of your software.

Comprehensive Metadata Extraction

The Metadata Extractor for FAIRsoft performs a comprehensive analysis of your GitHub repository, ensuring all relevant information is captured. Here’s what the extraction process includes:

• GitHub GraphQL API Integration: Gathers essential repository data such as descriptions, versioning, and licensing information.

• Contributor Identification: Scans the commit history to accurately list all contributors to the project.

• Citation Discovery: Scans the README for BibTeX citations and parses CITATION.cff files for formal citation details.

• Documentation Detection: Identifies key documentation files in the root directory, like CONTRIBUTING, CHANGELOG, and INSTALL.

Metadata Management and Enhancement

This rich metadata can be reviewed, edited, and enhanced through the FAIRsoft Evaluator. The platform also allows you to generate standardized metadata files, such as CITATION.cff, and push them to your repository via pull requests. These files can be downloaded for offline use or manual integration.

Flexible API Integration

For managing metadata across multiple repositories or automating extraction processes, the API provides powerful integration options. If you lack permissions to install the app directly on a repository, you can still use the API with a personal access token, ensuring you can extract and manage metadata even in restricted environments.

Security and Privacy

We take your security and privacy seriously. The Metadata Extractor for FAIRsoft requires only read-only permissions to access your GitHub repository. This means that the app can view and extract metadata, but it cannot make any changes to your repository’s content.

What Read-Only Permissions Mean:

• No Write Access: The app does not have the ability to modify, delete, or add files to your repository. This ensures that your code and repository settings remain untouched and safe from unintended changes.

• Metadata Extraction Only: The app’s sole function with read-only permissions is to extract and analyze metadata. All edits, updates, or pushes to the repository, such as through pull requests, are initiated by you through the FAIRsoft Evaluator platform.

• Secure Data Handling: Since the app only reads data, it minimizes potential security risks associated with more extensive permissions. Your repository’s data is accessed solely for the purpose of metadata extraction, with no risk of alteration.

No Data Retention:

• No Data Storage: Neither the Metadata Extractor for FAIRsoft nor the FAIRsoft Evaluator retain any data from your repositories. All metadata is used only during your active session and is not stored.

• Complete Privacy: Once your session ends, all extracted data is discarded, ensuring your repository's information remains private and secure.

These read-only permissions and our strict no data retention policy are designed to protect your repository and ensure your privacy, allowing you to confidently use the FAIRsoft Evaluator to enhance the visibility, accessibility, and reusability of your software.