Metadata-Version: 2.1
Name: pontos
Version: 0.2.0
Summary: Common utilities and tools maintained by Greenbone Networks
Home-page: UNKNOWN
Author: Greenbone Networks GmbH
Author-email: info@greenbone.net
License: GPL-3.0-or-later
Description: .. role:: raw-html-m2r(raw)
           :format: html
        
        
        
        .. image:: https://www.greenbone.net/wp-content/uploads/gb_logo_resilience_horizontal.png
           :target: https://www.greenbone.net/wp-content/uploads/gb_logo_resilience_horizontal.png
           :alt: Greenbone Logo
        
        
        Pontos - Greenbone Python Utilities and Tools :raw-html-m2r:`<!-- omit in toc -->`
        ======================================================================================
        
        
        .. image:: https://img.shields.io/github/release/greenbone/pontos.svg
           :target: https://github.com/greenbone/pontos/releases
           :alt: GitHub releases
        
        
        .. image:: https://img.shields.io/pypi/v/pontos.svg
           :target: https://pypi.org/project/pontos/
           :alt: PyPI release
        
        
        .. image:: https://codecov.io/gh/greenbone/pontos/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/greenbone/pontos
           :alt: code test coverage
        
        
        .. image:: https://circleci.com/gh/greenbone/pontos/tree/master.svg?style=svg
           :target: https://circleci.com/gh/greenbone/pontos/tree/master
           :alt: CircleCI
        
        
        The **pontos** Python package is a collection of utilities, tools, classes and
        function for maintained by `Greenbone Networks <https://www.greenbone.net/>`_.
        
        Pontos is the German name of the Greek titan `Pontus <https://en.wikipedia.org/wiki/Pontus_(mythology>`_\ ),
        the titan of the sea.
        
        Table of Contents :raw-html-m2r:`<!-- omit in toc -->`
        ----------------------------------------------------------
        
        
        * `Installation <#installation>`_
        
          * `Requirements <#requirements>`_
          * `Install using pip <#install-using-pip>`_
          * `Install using poetry <#install-using-poetry>`_
        
        * `Development <#development>`_
        * `Maintainer <#maintainer>`_
        * `Contributing <#contributing>`_
        * `License <#license>`_
        
        Installation
        ------------
        
        Requirements
        ^^^^^^^^^^^^
        
        Python 3.5 and later is supported.
        
        Install using pip
        ^^^^^^^^^^^^^^^^^
        
        pip 19.0 or later is required.
        
        ..
        
           **Note**\ : All commands listed here use the general tool names. If some of
           these tools are provided by your distribution, you may need to explicitly use
           the Python 3 version of the tool, e.g. **\ ``pip3``\ **.
        
        
        You can install the latest stable release of **pontos** from the Python
        Package Index (pypi) using `pip <https://pip.pypa.io/>`_
        
        .. code-block::
        
           pip install --user pontos
        
        
        Install using poetry
        ^^^^^^^^^^^^^^^^^^^^
        
        Because **pontos** is a Python library you most likely need a tool to
        handle Python package dependencies and Python environments. Therefore we
        strongly recommend using `pipenv <https://pipenv.pypa.io/>`_ or `poetry <https://python-poetry.org/>`_.
        
        You can install the latest stable release of **pontos** and add it as
        a dependency for your current project using `poetry <https://python-poetry.org/>`_
        
        .. code-block::
        
           poetry add pontos
        
        
        For installation via pipenv please take a look at their `documentation <https://pipenv.pypa.io/>`_.
        
        Development
        -----------
        
        **pontos** uses `poetry <https://python-poetry.org/>`_ for its own dependency management and build
        process.
        
        First install poetry via pip
        
        .. code-block::
        
           pip install --user poetry
        
        
        Afterwards run
        
        .. code-block::
        
           poetry install
        
        
        in the checkout directory of **pontos** (the directory containing the
        ``pyproject.toml`` file) to install all dependencies including the packages only
        required for development.
        
        Afterwards activate the git hooks for auto-formatting and linting via
        `autohooks <https://github.com/greenbone/autohooks>`_.
        
        .. code-block::
        
           poetry run autohooks activate
        
        
        Validate the activated git hooks by running
        
        .. code-block::
        
           poetry run autohooks check
        
        
        Maintainer
        ----------
        
        This project is maintained by `Greenbone Networks GmbH <https://www.greenbone.net/>`_
        
        Contributing
        ------------
        
        Your contributions are highly appreciated. Please
        `create a pull request <https://github.com/greenbone/pontos/pulls>`_
        on GitHub. Bigger changes need to be discussed with the development team via the
        `issues section at GitHub <https://github.com/greenbone/pontos/issues>`_
        first.
        
        License
        -------
        
        Copyright (C) 2020 `Greenbone Networks GmbH <https://www.greenbone.net/>`_
        
        Licensed under the `GNU General Public License v3.0 or later <LICENSE>`_.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: ==3.*,>=3.5.0
Provides-Extra: dev
