fairops.repositories package

fairops.repositories.figshare module

class fairops.repositories.figshare.FigshareClient(api_token: str)

Bases: object

A client for interacting with the Figshare API to manage projects, articles, and file uploads/downloads.

Initialize the Figshare client with an API token.

Args:

api_token (str): The Figshare API token for authentication.

create_article_in_project(project_id: int, title: str) → int

Create a new article within a Figshare project.

Args:

project_id (int): The Figshare project ID. title (str): The title of the article.

Returns:

int: The newly created article ID.

create_project(title: str, description: str) → int

Create a new project on Figshare.

Args:

title (str): The title of the project. description (str): A description of the project.

Returns:

int: The newly created project ID.

delete_article(article_id: int)

delete_project(project_id: int)

download_files_by_doi(doi: str, output_path: str) → str

Download files using a Figshare DOI.

Args:

doi (str): The DOI of the Figshare article. output_path (str): Local directory to save downloaded files.

Returns:

str: Path to the downloaded files, or None if the article is not found.

download_files_by_id(article_id: int, output_path: str, private=False) → str

Download all files associated with an article.

Args:

article_id (int): The Figshare article ID. output_path (str): Local directory to save downloaded files.

Returns:

str: Path to the downloaded files.

upload_files_to_project(project_id: int, title: str, file_paths: list)

Upload multiple files to a Figshare project.

Args:

project_id (int): The Figshare project ID. title (str): The article title. file_paths (list): List of file paths to upload.

fairops.repositories.zenodo module

class fairops.repositories.zenodo.FileWithProgress(file_path, desc=None)

Bases: object

close()

read(size=-1)

class fairops.repositories.zenodo.ZenodoClient(api_token: str)

Bases: object

A client for interacting with the Zenodo API to manage projects, articles, and file uploads/downloads.

Initialize the Zenodo client with an API token.

Args:

api_token (str): The Zenodo API token for authentication.

create_project(title: str, description: str)

Create a draft record in Zenodo.

download_files_by_doi(doi, download_dir)

Download all files from a Zenodo record given its DOI.

download_files_by_id(record_id, download_path, private=False)

Download a file from Zenodo.

upload_files_to_project(project_id, file_paths, title=None)

Upload a large file to Zenodo draft using PUT (streaming upload).