Data

Tools

Indexes

Applications

Experiments

Open Source Science

wolfsoftware.dockerhub-extractor

Extract container information for a given user in DockerHub.

https://github.com/developerstoolbox/dockerhub-extractor-package

Science Score: 44.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
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.9%) to scientific vocabulary

Keywords

dockerhub wolfsoftware
Last synced: 4 months ago · JSON representation ·

Repository

Extract container information for a given user in DockerHub.

Basic Info
  • Host: GitHub
  • Owner: DevelopersToolbox
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 192 KB
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 0
  • Open Issues: 6
  • Releases: 3
Topics
dockerhub wolfsoftware
Created over 1 year ago · Last pushed 5 months ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Codeowners Security

README.md

DevelopersToolbox logo
Github Build Status License Created
Release Released Commits since release

Overview

DockerHub Extractor is a Python package designed to fetch and process detailed information about repositories hosted on Docker Hub. This package is particularly useful for users who want to retrieve and analyze metadata for repositories maintained by a specific Docker Hub user.

Features

  • Retrieve a list of repositories maintained by a specific Docker Hub user.
  • Fetch detailed metadata for each repository, including information such as tags, stars, pulls, and more.
  • Custom exceptions for handling errors gracefully.
  • Option to set the Docker Hub username after initializing the class.

Installation

You can install the package using pip:

sh pip install wolfsoftware.dockerhub-extractor

Usage

Basic Usage

Here's a basic example of how to use the DockerHub Extractor:

```python from wolfsoftware.dockerhub_extractor import DockerHubExtractor

Initialize without username

dockerhub_extractor = DockerHubExtractor()

Set username later

dockerhubextractor.setusername("yourdockerhubusername")

Get detailed information for all repositories

try: repositoriesdetails = dockerhubextractor.getallrepositoriesdetails() print(repositoriesdetails) except DockerHubExtractorError as e: print(f"An error occurred: {e.message}") ```

Setting Username During Initialization

You can also set the username during initialization:

python dockerhub_extractor = DockerHubExtractor("your_dockerhub_username")

Retrieving User Repositories

You can retrieve a list of repositories maintained by a specific user:

python repositories = dockerhub_extractor.get_user_repositories() print(repositories)

Retrieving Repository Details

To get detailed information about a specific repository:

python repository_details = dockerhub_extractor.get_repository_details("repository_name") print(repository_details)

API Reference

Classes

DockerHubExtractor

A class to fetch and process repository details for a given Docker Hub user.

__init__(self, username: str)
  • Initializes the DockerHubExtractor with a username.
  • Parameters:
    • username (str): The Docker Hub username.
  • Raises:
    • DockerHubExtractorError: If the username is not provided.
set_username(self, username: str)
  • Sets the Docker Hub username.
  • Parameters:
    • username (str): The Docker Hub username.
  • Raises:
    • DockerHubExtractorError: If the username is not provided.
get_user_repositories(self) -> list
  • Fetches the list of repositories for the given Docker Hub user.
  • Returns:
    • list: A list of dictionaries containing repository names and summaries.
  • Raises:
    • DockerHubExtractorError: If there is an error fetching or parsing the user profile.
get_repository_details(self, repository_name: str) -> dict
  • Fetches detailed information for a specific repository.
  • Parameters:
    • repository_name (str): The name of the repository.
  • Returns:
    • dict: A dictionary containing detailed information about the repository.
  • Raises:
    • DockerHubExtractorError: If there is an error fetching or parsing the repository details.
get_all_repositories_details(self) -> list
  • Fetches detailed information for all repositories of the given Docker Hub user.
  • Returns:
    • list: A list of dictionaries containing detailed information about each repository.
  • Raises:
    • DockerHubExtractorError: If there is an error fetching or processing the repository details.

DockerHubExtractorError

Custom exception class for DockerHubExtractor errors.


Owner

  • Name: Developers Toolbox
  • Login: DevelopersToolbox
  • Kind: organization
  • Email: github@wolfsoftware.com
  • Location: United Kingdom

A selection of tools to help developers. Created by Wolf Software.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: DockerHub Extractor
abstract: Extract container information for a given user in DockerHub.
type: software
version: 0.1.1
date-released: 2024-06-26
repository-code: https://github.com/DevelopersToolbox/dockerhub-extractor-package
keywords:
  - "Wolf Software"
  - "Software"
license: MIT
authors:
  - family-names: "Wolf"
    orcid: "https://orcid.org/0009-0007-0983-2072"

GitHub Events

Total
  • Delete event: 82
  • Issue comment event: 170
  • Push event: 128
  • Pull request review event: 128
  • Pull request event: 158
  • Create event: 83
Last Year
  • Delete event: 82
  • Issue comment event: 170
  • Push event: 128
  • Pull request review event: 128
  • Pull request event: 158
  • Create event: 83

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 0
  • Total pull requests: 123
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 days
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 1.57
  • Merged pull requests: 83
  • Bot issues: 0
  • Bot pull requests: 122
Past Year
  • Issues: 0
  • Pull requests: 96
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.51
  • Merged pull requests: 61
  • Bot issues: 0
  • Bot pull requests: 96
View more stats
Top Authors
Issue Authors
  • dependabot[bot] (2)
Pull Request Authors
  • dependabot[bot] (179)
  • TGWolf (1)
Top Labels
Issue Labels
dependabot: auto approve (2) dependabot: auto merge (2) dependabot: dependencies (2) dependabot: ecosystem : python (1) dependabot: ecosystem : github actions (1)
Pull Request Labels
dependabot: dependencies (179) dependabot: auto approve (131) dependabot: auto merge (131) dependabot: ecosystem : github actions (127) dependabot: ecosystem : python (52) dependabot: manual merge (25)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 7 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 1
pypi.org: wolfsoftware.dockerhub-extractor

Extract container information for a given user in DockerHub.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 7 Last month
Rankings
Dependent packages count: 10.8%
Average: 35.8%
Dependent repos count: 60.8%
Maintainers (1)
WolfSoftware
Last synced: 4 months ago