Skip to content

workspace module

Create and view projects on D2S instance.

Source code in d2spy/workspace.py 
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
class Workspace:
    """Create and view projects on D2S instance."""

    def __init__(self, base_url: str, session: D2SpySession, api_key: str = ""):
        self.api_key = api_key
        self.base_url = base_url
        self.session = session

        self.client = APIClient(self.base_url, self.session)

    @classmethod
    def connect(cls, base_url: str, email: str) -> "Workspace":
        """Login and create workspace.

        Args:
            base_url (str): Base URL for D2S instance.
            email (str): Email address used to sign in to D2S.

        Returns:
            Workspace: D2S workspace for creating and viewing data.
        """
        auth = Auth(base_url)
        auth.login(email=email)

        # Set user api key if available
        if hasattr(auth.session, "d2s_data"):
            api_key = auth.session.d2s_data["API_KEY"]
        else:
            api_key = ""

        return cls(base_url, auth.session, api_key)

    def logout(self) -> None:
        """Logout of D2S platform."""
        # Delete access-token cookie from session and end session
        self.session.cookies.clear(domain="", path="/", name="access_token")
        self.session.close()
        print("session ended")

    def add_project(
        self,
        title: str,
        description: str,
        location: dict,
        planting_date: Optional[datetime] = None,
        harvest_date: Optional[datetime] = None,
    ) -> models.Project:
        """Create new project in workspace.

        Args:
            title (str): Title for project.
            description (str): Description of project.
            location (dict): GeoJSON object representing location of project.
            planting_date (Optional[datetime]): Planting date. Defaults to None.
            harvest_date (Optional[datetime]): Harvest date. Defaults to None.

        Returns:
            models.Project: New project instance.
        """
        endpoint = "/api/v1/projects"
        data = {
            "title": title,
            "description": description,
            "location": location,
            "planting_date": planting_date,
            "harvest_date": harvest_date,
        }

        response_data = self.client.make_post_request(endpoint, json=data)
        project = schemas.Project.from_dict(response_data)
        return models.Project(self.client, **project.__dict__)

    def get_project(self, project_id: str) -> Optional[models.Project]:
        """Request single project by ID. Project must be active and viewable by user.

        Args:
            project_id (str): Project ID.

        Returns:
            Optional[models.Project]: Project matching ID or None.
        """
        endpoint = f"/api/v1/projects/{project_id}"
        response_data = self.client.make_get_request(endpoint)
        response_data = ensure_dict(response_data)
        project = schemas.Project.from_dict(response_data)
        return models.Project(self.client, **project.__dict__)

    def get_projects(self, has_raster: Optional[bool] = False) -> ProjectCollection:
        """Request multiple projects. Only active projects viewable by
        user will be returned.

        Args:
            has_raster (Optional[bool], optional): Only return projects with rasters.

        Returns:
            ProjectCollection: Collection of all projects viewable by user.
        """
        endpoint = "/api/v1/projects"
        response_data = self.client.make_get_request(
            endpoint, params={"has_raster": has_raster}
        )
        response_data = ensure_list_of_dict(response_data)
        projects = [
            models.Project(
                self.client, **schemas.MultiProject.from_dict(project).__dict__
            )
            for project in response_data
        ]
        return ProjectCollection(collection=projects)

add_project(title, description, location, planting_date=None, harvest_date=None)

Create new project in workspace.

Parameters:

Name Type Description Default
title str

Title for project.

 required
description str

Description of project.

 required
location dict

GeoJSON object representing location of project.

 required
planting_date Optional[datetime]

Planting date. Defaults to None.

 None
harvest_date Optional[datetime]

Harvest date. Defaults to None.

 None

Returns:

Type Description
Project

models.Project: New project instance.
Source code in d2spy/workspace.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def add_project(
    self,
    title: str,
    description: str,
    location: dict,
    planting_date: Optional[datetime] = None,
    harvest_date: Optional[datetime] = None,
) -> models.Project:
    """Create new project in workspace.

    Args:
        title (str): Title for project.
        description (str): Description of project.
        location (dict): GeoJSON object representing location of project.
        planting_date (Optional[datetime]): Planting date. Defaults to None.
        harvest_date (Optional[datetime]): Harvest date. Defaults to None.

    Returns:
        models.Project: New project instance.
    """
    endpoint = "/api/v1/projects"
    data = {
        "title": title,
        "description": description,
        "location": location,
        "planting_date": planting_date,
        "harvest_date": harvest_date,
    }

    response_data = self.client.make_post_request(endpoint, json=data)
    project = schemas.Project.from_dict(response_data)
    return models.Project(self.client, **project.__dict__)

connect(base_url, email) classmethod

Login and create workspace.

Parameters:

Name Type Description Default
base_url str

Base URL for D2S instance.

 required
email str

Email address used to sign in to D2S.

 required

Returns:

Name Type Description
Workspace Workspace

D2S workspace for creating and viewing data.
Source code in d2spy/workspace.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
@classmethod
def connect(cls, base_url: str, email: str) -> "Workspace":
    """Login and create workspace.

    Args:
        base_url (str): Base URL for D2S instance.
        email (str): Email address used to sign in to D2S.

    Returns:
        Workspace: D2S workspace for creating and viewing data.
    """
    auth = Auth(base_url)
    auth.login(email=email)

    # Set user api key if available
    if hasattr(auth.session, "d2s_data"):
        api_key = auth.session.d2s_data["API_KEY"]
    else:
        api_key = ""

    return cls(base_url, auth.session, api_key)

get_project(project_id)

Request single project by ID. Project must be active and viewable by user.

Parameters:

Name Type Description Default
project_id str

Project ID.

 required

Returns:

Type Description
Optional[Project]

Optional[models.Project]: Project matching ID or None.
Source code in d2spy/workspace.py 
84
85
86
87
88
89
90
91
92
93
94
95
96
97
def get_project(self, project_id: str) -> Optional[models.Project]:
    """Request single project by ID. Project must be active and viewable by user.

    Args:
        project_id (str): Project ID.

    Returns:
        Optional[models.Project]: Project matching ID or None.
    """
    endpoint = f"/api/v1/projects/{project_id}"
    response_data = self.client.make_get_request(endpoint)
    response_data = ensure_dict(response_data)
    project = schemas.Project.from_dict(response_data)
    return models.Project(self.client, **project.__dict__)

get_projects(has_raster=False)

Request multiple projects. Only active projects viewable by user will be returned.

Parameters:

Name Type Description Default
has_raster Optional[bool]

Only return projects with rasters.

 False

Returns:

Name Type Description
ProjectCollection ProjectCollection

Collection of all projects viewable by user.
Source code in d2spy/workspace.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def get_projects(self, has_raster: Optional[bool] = False) -> ProjectCollection:
    """Request multiple projects. Only active projects viewable by
    user will be returned.

    Args:
        has_raster (Optional[bool], optional): Only return projects with rasters.

    Returns:
        ProjectCollection: Collection of all projects viewable by user.
    """
    endpoint = "/api/v1/projects"
    response_data = self.client.make_get_request(
        endpoint, params={"has_raster": has_raster}
    )
    response_data = ensure_list_of_dict(response_data)
    projects = [
        models.Project(
            self.client, **schemas.MultiProject.from_dict(project).__dict__
        )
        for project in response_data
    ]
    return ProjectCollection(collection=projects)

logout()

Logout of D2S platform.

Source code in d2spy/workspace.py 
44
45
46
47
48
49
def logout(self) -> None:
    """Logout of D2S platform."""
    # Delete access-token cookie from session and end session
    self.session.cookies.clear(domain="", path="/", name="access_token")
    self.session.close()
    print("session ended")