/d8s-netstrings

Democritus functions for working with Netstrings.

Primary LanguagePythonGNU Lesser General Public License v3.0LGPL-3.0

Democritus Netstrings

PyPI CI Lint codecov The Democritus Project uses semver version 2.0.0 The Democritus Project uses black to format code License: LGPL v3

Democritus functions[1] for working with Netstrings.

[1] Democritus functions are simple, effective, modular, well-tested, and well-documented Python functions.

We use d8s (pronounced "dee-eights") as an abbreviation for democritus (you can read more about this here).

Installation

pip install d8s-netstrings

Usage

You import the library like:

from d8s_netstrings import *

Once imported, you can use any of the functions listed below.

Functions

  • def string_to_netstring_ascii(string: str, *args):
        """Convert the given string to a netstring (and return it's ascii representation)."""
  • def string_to_netstring_hex(string: str, *args):
        """Convert the given string to a netstring (and return it's hex representation)."""
  • def netstring_ascii_to_netstring_hex(netstring_ascii: str):
        """Convert a netstring (represented as ascii) to its hex representation."""
  • def netstring_hex_to_netstring_ascii(netstring_hex: str):
        """Convert a netstring (represented as hex) to its ascii representation."""
  • def netstring_ascii_to_string(netstring_ascii: str):
        """Get the string portion of the given netstring (represented as ascii)."""
  • def netstring_hex_to_string(netstring_hex: str):
        """Get the string portion of the given netstring (represented as hex)."""

Development

👋  If you want to get involved in this project, we have some short, helpful guides below:

If you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.

Credits

This package was created with Cookiecutter and Floyd Hightower's Python project template.