semvec/pypi-packages huggingface dataset:
polka-routing 0.2.2
PolKA - A Polynomial Scrict-Source Routing - Tools
License: mit
Requires Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7

======
PolKA
======


PolKA - A Novel Source Routing Mechanism Library

Description
===========

Python package that provides configuration access to PolKA Library.


.. warning:: This package is provisional and therefore should not be used in production.

Installation
============

Please make sure you have:

- a Python version greater than or equal to **3.6**,
- ``gcc``, ``make`` and Python headers installed (``sudo apt install build-essential python3-dev`` on Ubuntu)
- pip installed
- venv installed (``sudo apt install python3-venv`` on Ubuntu)
- access to the Github repository

.. code-block:: bash

    # Recommended create a venv:
    $ python3 -m venv .venv
    $ source .venv/bin/activate

    # Having the wheel package pre-installed in the venv helps to avoid errors
    $ pip install wheel

    # With SSH access:
    $ pip install git+ssh://git@github.com/nerds-ufes/polka.git@master#egg=polka
    # With HTTP access:
    $ pip install git+https://github.com/nerds-ufes/polka.git

    # Installing after cloning using git
    $ cd polka/
    $ python3 -m pip install . --user --upgrade

Optionally, to increase entropy (used for cryptography) the package ``rng-tools`` can
also be installed (``sudo apt install rng-tools`` on Ubuntu).

Overview
========

Low Level Python Library
------------------------

This package provide a Python library for interfacing the PolKA Mechanism.

Example:

.. code-block:: python

    from polka.tools import *
    from polka.generate import *
    from polka.analysis import *

Note
====

This project has been maintained by LabNERDS - Federal University of Espirito Santo. For details and usage
information, go to the page on https://github.com/nerds-ufes/PolKA.