Metadata-Version: 1.2
Name: gitlab-registry-usage
Version: 0.2.5
Summary: This is a package for querying the size of repositories in a GitLab registry.
Home-page: https://github.com/sciapp/gitlab-registry-usage
Author: Ingo Heimbach
Author-email: i.heimbach@fz-juelich.de
License: MIT
Description: GitLab-Registry-Usage
        =====================
        
        Introduction
        ------------
        
        *GitLab-Registry-Usage* is a package for querying the sizes of Docker
        repositories stored in a GitLab registry. The package has been created
        because it is not possible to monitor sizes of GitLab registry
        repositories with GitLab web monitoring tools (GitLab version <=
        10.5.4).
        
        Installation
        ------------
        
        The latest version is available from PyPI:
        
        .. code:: bash
        
           pip install gitlab-registry-usage
        
        Usage
        -----
        
        Command Line Interface
        ~~~~~~~~~~~~~~~~~~~~~~
        
        After installing with ``pip``, a ``gitlab-registry-usage`` command is
        available:
        
        .. code:: bash
        
           $ gitlab-registry-usage --help
           usage: gitlab-registry-usage [-h] [-g GITLAB_SERVER] [-r REGISTRY_SERVER]
                                        [-s {name,size,disksize}] [-c CREDENTIALS_FILE]
                                        [-u USERNAME] [-V]
        
           gitlab-registry-usage is a utility for querying the memory usage of repositories in a GitLab registry.
        
           optional arguments:
             -h, --help            show this help message and exit
             -g GITLAB_SERVER, --gitlab-server GITLAB_SERVER
                                   GitLab server hostname (for example `mygitlab.com`)
             -r REGISTRY_SERVER, --registry-server REGISTRY_SERVER
                                   GitLab registry server hostname (for example
                                   `registry.mygitlab.com`)
             -s {name,size,disksize}, --sort {name,size,disksize}
                                   sorting order (default: name)
             -c CREDENTIALS_FILE, --credentials-file CREDENTIALS_FILE
                                   path to a file containing username and password/access
                                   token (on two separate lines)
             -u USERNAME, --user USERNAME
                                   user account for querying the GitLab API (default:
                                   root)
             -V, --version         print the version number and exit
        
        You should specify a GitLab server hostname (``-g``), a GitLab registry
        server hostname (``-r``) and either a credentials file (``-c``) or
        username (``-u``) and password (read from stdin).
        
        API
        ~~~
        
        The module offers a high level ``GitLabRegistry`` class to query the
        repository catalog and repository sizes. This example prints all
        repositories, tags and their sizes:
        
        .. code:: python
        
           from gitlab_registry_usage import GitLabRegistry
        
           # TODO: set these values!
           gitlab_base_url = ''
           registry_base_url = ''
           username = 'root'
           access_token = '0000000000'
        
           gitlab_registry = GitLabRegistry(
               gitlab_base_url, registry_base_url, username, access_token
           )
           for repository in gitlab_registry.repository_tags.keys():
               repository_tags = gitlab_registry.repository_tags[repository]
               repository_size = gitlab_registry.repository_sizes[repository]
               repository_disk_size = gitlab_registry.repository_disk_sizes[repository]
               tag_sizes = gitlab_registry.tag_sizes[repository]
               tag_disk_sizes = gitlab_registry.tag_disk_sizes[repository]
               if (
                   repository_tags is not None and repository_size is not None
                   and repository_disk_size is not None and tag_sizes is not None
                   and tag_disk_sizes is not None
               ):
                   print(
                       '{}: repository size: {}, repository disk size: {}'.format(
                           repository, repository_size, repository_disk_size
                       )
                   )
                   for tag in repository_tags:
                       print(
                           '{}: tag size: {}, tag disk size: {}'.format(
                               tag, tag_sizes[tag], tag_disk_sizes[tag]
                           )
                       )
               else:
                   print('{}: no further information available'.format(repository))
               print()
           print(
               ('total size: {}, total disk size: {}').format(
                   gitlab_registry.total_size, gitlab_registry.total_disk_size
               )
           )
        
        The method ``delete_image`` can be used to delete a particular image if
        the corresponding SHA256 hash is known.
        
Keywords: Git,GitLab,Docker,Registry,disk capacity
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Version Control :: Git
Classifier: Topic :: System :: Systems Administration
Requires-Python: ~=3.3
