pyalteon

This library provides a Python interface to the Radware Alteon REST API. python-alteon is open sourced under the BSD 3-Clause license.

Basics

pyalteon still runs on Python 2.7, and Python >= 3.4

Features

Installing

You can use pip to install pyalteon:

pipenv install pyalteon

Examples

This is a simple example that just shows initializing the Client object and using it to query the Organization and SSL endpoints:

from pyalteon import Client

client = Client(
    hostname="vadc.example.org",
    username="your_username",
    password="your_password",
)

Contributing

Pull requests to add functionality and fix bugs are always welcome. Please check the CONTRIBUTING.md for specifics on contributions.

Testing

We try to have a high level of test coverage on the code. Therefore, when adding anything to the repo, tests should be written to test a new feature or to test a bug fix so that there won't be a regression. This library is setup to be pretty simple to build a working development environment using Docker. Therefore, it is suggested that you have Docker installed where you clone this repository to make development easier.

To start a development environment, you should be able to just run the dev.sh script. This script will use the Dockerfile in this repository to build a Docker container with all the dependencies for development installed using Poetry.

./dev.sh

The first time you run the script, it should build the Docker image and then drop you into the container's shell. The directory where you cloned this repository should be volume mounted in to /usr/src, which should also be the current working directory. From there, you can make changes as you see fit. Tests can be run from the /usr/src directory by simply typing green as green has been setup to with the correct parameters.