Skip to main content

An application framework with built-in drivers (Controllers), data holders (Sources) and config parsers (Rules). Also includes a web interface for configuration and troubleshooting.

Project description

Summary

An application framework with built-in drivers (Controllers), data holders (Sources) and config parsers (Rules). Also includes a web interface for configuration and troubleshooting.

Features

  • Abstract base classes for creating custom controllers, sources and rules
  • The configuration is done using configparser with extended interpolation
  • Start a new netdef project with cookiecutter. Templates available at https://bitbucket.org/fholmer/cookiecutter-netdef.

Built-in Controllers:

Built-in Rules:

  • Generic CSV config parser

Built-in application engines:

  • threaded engine with stdout/stderr only
  • threaded engine with web-interface (webadmin)
  • serve webadmin behind nginx reverse proxy

Use Cases

Netdef is useful if you want to create a middleware that can translate a protocol into a completely different protocol or data format into a completely different data format.

Getting started

First install cookiecutter and netdef templates:

$ python3 -m venv cookiecutter/
$ cookiecutter/bin/pip install cookiecutter
$ hg clone https://bitbucket.org/fholmer/cookiecutter-netdef cookiecutter/cookiecutter-netdef

Create your first application:

$ cookiecutter/bin/cookiecutter cookiecutter/cookiecutter-netdef/cookiecutter-minimal-app

Cookiecutter and netdef-templates can now be removed if you wish.

Setup your application:

$ cd your-application
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements-dev.txt
$ pip install -r requirements.txt

Project details


Download files

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

Files for netdef, version 1.0.4
Filename, size File type Python version Upload date Hashes
Filename, size netdef-1.0.4-py3-none-any.whl (106.5 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page