megaLib 1.0

megaLib is a Python wrapper for the Megaport RESTful API

megaLib

megaLib is a Python wrapper for the Megaport RESTful API.

Megaport operates a global, Software Defined Network which enables their customers to manage their connectivity in close to real time. The Megaport API allows customers to interact with their account in the same way as they might using the Web Portal.

Use the power of megaLib to order your very own virtual router in the cloud with connectivity to AWS in just a few lines:

Who Uses megaLib

Anyone who has an existing Megaport account and would like to automate Megaport things in Python. If you don't have an account you can signup here.

How it Works

megaLib functions as a Python wrapper for the public Megaport API by providing a library of functions to simplify your next mega-project.

If you would like more information on the Megaport API I suggest checking out the Megaport API documentation and the Megaport Knowledgebase Articles on the API.

Installation

Requests is required, Requests can be installed using pipenv or pip:

See the Requests documentation for alternative installation methods.

Install megaLib using pip:

Alternatively, install megaLib by cloning this git repository to a local directory, verifying the requirements are met and executing setup.py:

Usage

You can find example code snippets for the functions here. Examples of more functional code are here. Additional resources can be found on the Wiki.

Built With

Requests - Python HTTP Requests for Humans.

How to Contribute

1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
2. Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
3. Write a test which shows that the bug was fixed or that the feature works as expected.
4. Send a pull request and bug the maintainer until it gets merged and published.

License

This project is licensed under the GNU General Public License v3.0 - see LICENSE for more details.

Disclaimer

This project including this git repository, is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Megaport, or any of its subsidiaries or its affiliates.

Please refrain from contacting Megaport regarding any issues or support of this project. Instead feel free to submit an issue via this git repository.