pyros_api.py 3.83 KB
#!/usr/bin/env python3
import requests, sys, yaml, click

class PyrosAPI:
    """
    Request Pyros API with an PyrosUser account linked to the username and password
    """
    BASE_PYROS_URL = "http://localhost:8000/api/"

    def __init__(self, username: str, password: str) -> None:
        """
        Initialize PyrosAPI class by getting the authentification token required to use the API

        Args:
            username : Username of the user (mail adress)
            password : Password of the user
        """
        self.get_token(username, password)

    def get_token(self, username: str, password: str):
        """
        get the authentification token linked to the user account

        Args:
            username : Username of the user (mail adress)
            password : Password of the user
        """
        url = f"{self.BASE_PYROS_URL}api-token-auth/"
        request = requests.post(url, data={"username": username, "password": password})
        json_response = request.json()
        self.token = json_response["token"]
        print(f"Token is {self.token}")

    def get_url(self, url: str) -> dict:
        """
        Query the url and return the response as json

        Args:
            url : Url to be requested without the base url of the website 

        Returns:
            dict : Json object that represents the response of the API
        """
        headers = {"Authorization" : f"Token {self.token}"}

        request = requests.get(self.BASE_PYROS_URL+url, headers=headers)
        return request.json()

    def submit_sequence_file(self, file: str) -> dict:
        """
        Submit sequence file by querying the API via PUT method

        Args:
            file : File path to the sequence file to be uploaded

        Returns:
            dict : Json object that represents the response of the API
        """
        headers = {
            "Authorization" : f"Token {self.token}",
            'Content-type': 'application/json',
        }
        url = f"{self.BASE_PYROS_URL}submit_sequence"
        yaml_file = open(file, "r")
        sequence_file_as_dict = yaml.safe_load(yaml_file)
        print(f"File content : {sequence_file_as_dict}")
        request = requests.put(url, headers=headers, json=sequence_file_as_dict)
        print(f"Request status code {request.status_code}")
        return request.json()

    def get_sequences_for_period(self, start_date:str, end_date:str) -> dict:
        """
        Return all the sequence between two dates
        Args:
            start_date : start date of the period we want to retrieve (format : day/month/year, example : 13/02/2022)
            end_date : end date of the period we want to retrieve (same format as start_date)
        Returns:
            dict : Json object that represents the response of the API
        """
        url = f"{self.BASE_PYROS_URL}full_sequences/get_sequences_for_period/"
        headers = {"Authorization": f"Token {self.token}"}
        response = requests.get(url, params={"start_date": start_date, "end_date": end_date}, headers=headers)
        return response.json()

@click.group()
@click.argument("username")
@click.argument("password")
@click.pass_context
def cli(ctx, username, password):
    ctx.obj = PyrosAPI(username, password)


@cli.command("get_sequences")
@click.argument("start_date")
@click.argument("end_date")
@click.pass_obj
def get_sequences_for_period(api, start_date: str, end_date: str):
    response = api.get_sequences_for_period(start_date, end_date)
    print(response)


@cli.command("submit_sequence")
@click.argument("file_path")
@click.pass_obj
def submit_sequence(api, file_path):
    response = api.submit_sequence_file(file_path)
    print(response)

@cli.command("query_url")
@click.argument("url")
@click.pass_obj
def query_url(api, url):
    response = api.get_url(url)
    print(response)

if __name__ == '__main__':
    cli(obj={})