Welcome to PyFirecREST

PyFirecREST is a Python library to use the FirecREST API. With it, you can manage your resources from Python 3 scripts.

Installation

This package is in PyPi, and python3 -m pip install pyfirecrest should be enough. You can also clone it from Github and even modify according to your needs.

Requirements

• Python 3.7 or higher. Python 2 is not supported.

• The required Python packages are the following:

requests>=2.14.0
PyJWT>=2.4.0
typer[all]

Contents:

• Authorization
  • The pyFirecREST Authorization Object
• Tutorial
  • Simple blocking requests
  • Interact with the scheduler
  • Transfer of large files
  • Enable logging in your python code
  • Handling of errors
• Reference
  • The Firecrest class
  • The ExternalUpload class
  • The ExternalDownload class
  • The ClientCredentialsAuth class

Contact

In case of questions/bugs/feature requests feel free to open issues in the public repository in Github.