Skip to content

Projects

Bases: MermaidBase

A class for handling MERMAID projects.

The Project class is responsible for fetching and searching projects from MERMAID. It provides methods to list your projects and search all projects based on specified criteria.

Attributes:

Name Type Description
PROJECT_STATUS_OPEN int

The project status value representing open projects.
Source code in seasnake/projects.py 
 6
 7
 8
 9
10
11
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
class Project(MermaidBase):
    """
    A class for handling MERMAID projects.

    The Project class is responsible for fetching and searching projects from MERMAID.
    It provides methods to list your projects and search all projects based on specified criteria.

    Attributes:
        PROJECT_STATUS_OPEN (int): The project status value representing open projects.
    """

    PROJECT_STATUS_OPEN = 90

    def my_projects(self) -> DataFrame:
        """
        Get a list of your projects.

        This method retrieves a list of your projects.

        Returns:
            DataFrame

        Examples:
        ```
        from seasnake import MermaidAuth, Project

        auth = MermaidAuth()
        project = Project(token=auth.get_token())
        print(project.my_projects())
        ```
        """

        url = "/projects/"
        return self.data_frame_from_url(url)

    def search_projects(
        self,
        name: Optional[str] = None,
        countries: Union[None, str, List[str]] = None,
        tags: Union[None, str, List[str]] = None,
        include_test_projects: bool = False,
    ) -> DataFrame:
        """
        Searches all MERMAID projects and filters results based on the specified criteria.

        Args:
            name (Optional[str], optional): A name or list of names to search for in
                projects. Defaults to None.
            countries (Union[None, str, List[str]], optional): A country to search for
                in projects. Defaults to None.
            tags (Union[None, str, List[str]], optional): A tag or list of tags to search
                for in projects. Defaults to None.
            include_test_projects (bool, optional): Whether to include test projects in
                the search results. Defaults to False.

        Returns:
            DataFrame

        Examples:
        ```
        from seasnake import Project

        project = Project()
        print(project.search_projects(tags=["WCS Fiji""]))
        ```
        """

        url = "/projects/"

        query_params = {"showall": "t"}
        if tags:
            query_params["tags"] = tags if isinstance(tags, str) else ",".join(tags)
        if not include_test_projects:
            query_params["status"] = str(self.PROJECT_STATUS_OPEN)

        df = self.data_frame_from_url(url, query_params=query_params)

        if name:
            raise NotImplementedError("Searching by name is not yet implemented.")
            # query_params["name"] = name
        if countries:
            raise NotImplementedError("Searching by country is not yet implemented.")
            # query_params["countries"] = countries

        return df

my_projects()

Get a list of your projects.

This method retrieves a list of your projects.

Returns:

Type Description
DataFrame

DataFrame

Examples:

from seasnake import MermaidAuth, Project

auth = MermaidAuth()
project = Project(token=auth.get_token())
print(project.my_projects())
Source code in seasnake/projects.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def my_projects(self) -> DataFrame:
    """
    Get a list of your projects.

    This method retrieves a list of your projects.

    Returns:
        DataFrame

    Examples:
    ```
    from seasnake import MermaidAuth, Project

    auth = MermaidAuth()
    project = Project(token=auth.get_token())
    print(project.my_projects())
    ```
    """

    url = "/projects/"
    return self.data_frame_from_url(url)

search_projects(name=None, countries=None, tags=None, include_test_projects=False)

Searches all MERMAID projects and filters results based on the specified criteria.

Parameters:

Name Type Description Default
name Optional[str]

A name or list of names to search for in projects. Defaults to None.

 None
countries Union[None, str, List[str]]

A country to search for in projects. Defaults to None.

 None
tags Union[None, str, List[str]]

A tag or list of tags to search for in projects. Defaults to None.

 None
include_test_projects bool

Whether to include test projects in the search results. Defaults to False.

 False

Returns:

Type Description
DataFrame

DataFrame

Examples:

from seasnake import Project

project = Project()
print(project.search_projects(tags=["WCS Fiji""]))
Source code in seasnake/projects.py 
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
def search_projects(
    self,
    name: Optional[str] = None,
    countries: Union[None, str, List[str]] = None,
    tags: Union[None, str, List[str]] = None,
    include_test_projects: bool = False,
) -> DataFrame:
    """
    Searches all MERMAID projects and filters results based on the specified criteria.

    Args:
        name (Optional[str], optional): A name or list of names to search for in
            projects. Defaults to None.
        countries (Union[None, str, List[str]], optional): A country to search for
            in projects. Defaults to None.
        tags (Union[None, str, List[str]], optional): A tag or list of tags to search
            for in projects. Defaults to None.
        include_test_projects (bool, optional): Whether to include test projects in
            the search results. Defaults to False.

    Returns:
        DataFrame

    Examples:
    ```
    from seasnake import Project

    project = Project()
    print(project.search_projects(tags=["WCS Fiji""]))
    ```
    """

    url = "/projects/"

    query_params = {"showall": "t"}
    if tags:
        query_params["tags"] = tags if isinstance(tags, str) else ",".join(tags)
    if not include_test_projects:
        query_params["status"] = str(self.PROJECT_STATUS_OPEN)

    df = self.data_frame_from_url(url, query_params=query_params)

    if name:
        raise NotImplementedError("Searching by name is not yet implemented.")
        # query_params["name"] = name
    if countries:
        raise NotImplementedError("Searching by country is not yet implemented.")
        # query_params["countries"] = countries

    return df