:py:mod:`glpkg.package`
=======================

.. py:module:: glpkg.package


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   glpkg.package.Package
   glpkg.package.UploadedPackage



Functions
~~~~~~~~~

.. autoapisummary::

   glpkg.package.gitlab_instance_dirname



.. py:class:: Package

   Normalized representation of a single package from glpkg.json

   .. py:attribute:: config
      :annotation: :glpkg.config.Config

      

   .. py:attribute:: alias
      :annotation: :str

      

   .. py:attribute:: name
      :annotation: :str

      

   .. py:attribute:: version
      :annotation: :str

      

   .. py:attribute:: filename
      :annotation: :str

      

   .. py:attribute:: gitlab_instance
      :annotation: :str

      

   .. py:attribute:: project_id
      :annotation: :int

      

   .. py:method:: __post_init__()


   .. py:method:: get_subpath() -> str

      Get string representing both package path in the download directory and
      its key in the lockfile


   .. py:method:: get_url() -> str

      Get URL pointing to the package location on the GitLab instance


   .. py:method:: get_path() -> pathlib.Path

      Get path to this package



.. py:class:: UploadedPackage(config: glpkg.config.Config, alias: str, name: str, version: str, filename: str, gitlab_instance: str, project_id: int, build: str)

   Bases: :py:obj:`Package`

   A :class:`Package` subclass for built and uploaded packages. It's an
   equivalent to a value in the "upload" dict


.. py:function:: gitlab_instance_dirname(instance_url: str) -> str

   Replace various characters in the GitLab instance URL, so that it can be
   used as a directory name