Skip to main content

Democritus functions for working with asns.

Project description

Democritus Asns

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

[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-asns

Usage

You import the library like:

from d8s_asns import *

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

Functions

  • def asn_standardize(as_number: str) -> Optional[str]:
        """Standardize the ASN format."""
    
  • def standardize_asn_decorator(func):
        """Standardize the first argument as an ASN."""
    
  • def asn_announced_prefixes(as_number: str) -> Iterable[str]:
        """."""
    
  • def asn_adjacent_asns(as_number: str) -> Iterable[str]:
        """."""
    
  • def asns_find(text: str) -> Iterable[str]:
        """Parse ASNs from the given text."""
    
  • def asns() -> Iterable[Tuple[str, str]]:
        """Get a list of ASNs from http://bgp.potaroo.net/as1221/asnames.txt."""
    
  • def asn_number(as_number: str) -> int:
        """Get the number value of the given ASN."""
    
  • def asn_is_private(as_number: str) -> bool:
        """Check if the given ASN is private."""
    
  • def asns_private_numbers() -> Iterable[int]:
        """Return the reserved (private) ASN numbers.
    
    Data is collected from:
    
    https://www.iana.org/assignments/iana-as-numbers-special-registry/iana-as-numbers-special-registry.xhtml
    
    This function only returns the private ASN numbers.
    The `asns_private_ranges` function returns more information about the private ASN ranges."""
    
  • def asns_private_ranges() -> List[Dict[str, str]]:
        """Return the reserved (private) ASN ranges.
    
    Data is collected from:
    
    https://www.iana.org/assignments/iana-as-numbers-special-registry/iana-as-numbers-special-registry.xhtml"""
    
  • def asn_name(as_number: str) -> Optional[str]:
        """Get the name of the given asn."""
    

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

d8s_asns-0.7.0.tar.gz (26.5 kB view hashes)

Uploaded Source

Built Distribution

d8s_asns-0.7.0-py2.py3-none-any.whl (22.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page