:py:mod:`glpkg`
===============

.. py:module:: glpkg


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   app/index.rst
   config/index.rst
   package/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   glpkg.Config
   glpkg.Package




.. py:class:: Config(root: pathlib.Path, downloads: Dict[str, glpkg.package.Package] = {}, uploads: Dict[str, glpkg.package.UploadedPackage] = {})

   Normalized representation of glpkg.json and user config

   .. py:method:: load(root: Optional[pathlib.Path] = None) -> Config
      :staticmethod:

      Find glpkg.json and initialize :class:`glpkg.Config` from it.

      :param root: the path from which the search should be started.


   .. py:method:: find_package(alias: str) -> glpkg.package.Package

      Find a package by its alias.

      :raises glpkg.error.PackageNotFoundError: if package was not found


   .. py:method:: find_download(alias: str) -> glpkg.package.Package

      Find downloaded package by its alias.

      :raises glpkg.error.PackageNotFoundError: if package was not found


   .. py:method:: find_upload(alias: str) -> glpkg.package.UploadedPackage

      Find uploaded package by its alias.

      :raises glpkg.error.PackageNotFoundError: if package was not found



.. 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