RESTfly: Simplifying API Libraries

Release v1.4.7.

RESTfly (pronounced restfully) is a framework for building libraries to easily interact with RESTful APIs.

The User Guide

This part of the documentation focuses on walking through usage of the library in a step-by-step manner.

Note

Please note that this section of the documentation is currently still being constructed, and should not be considered a complete walkthrough.

• Introduction
  • Philosophy
  • MIT License
  • RESTfly License
• Installation
  • Quick Install
  • Manual Install
• Getting Started
  • Calling a Simple Unauthenticated API
  • Using APIEndpoint
  • Using Authentication
  • Context handling and authentication
• Pagination

The API Documentation / Guide

If you are looking for information on a specific function, class, or method, this part of the documentation is what you’re looking for.

• Endpoints
• Errors
• Iterators
• Sessions
• Utils

Libraries Using RESTfly

RESTfly is a fairly new library based on the work of Steve McGrath within the pyTenable project. There are several other projects also leveraging RESTfly listed below:

• pyCheckpoint-API
• python-Cybereason
• pyTenable
• pyZScaler
• python-SecurityTrails
• Various Tenable integrations: - Azure Security Center Integration - Google CSCC Integration - Jira Cloud Integration - Tenable.asm Asset Importer