Add repositories, authors and frontpage like search.

Author: alefnula

paperswithcode/client.py

@@ -9,7 +9,11 @@
 from paperswithcode.models import (
     Paper,
     Papers,
+    Repository,
     Repositories,
+    PaperRepos,
+    Author,
+    Authors,
     Conference,
     Conferences,
     Proceeding,
@@ -69,7 +73,7 @@ def __parse(url: str) -> int:
             return 1
         else:
             q = parse.parse_qs(p.query)
-            return q.get("page", [1])[0]
+            return int(q.get("page", [1])[0])
 
     @classmethod
     def __page(cls, result, page_model):
@@ -86,6 +90,34 @@ def __page(cls, result, page_model):
             results=result["results"],
         )
 
+    @handler
+    def search(
+        self,
+        q: Optional[str] = None,
+        page: int = 1,
+        items_per_page: int = 50,
+    ) -> PaperRepos:
+        """Search in a similar fashion to the frontpage search.
+
+        Args:
+            q (str, optional): Filter papers by querying the paper title and
+                abstract.
+            page (int): Desired page.
+            items_per_page (int): Desired number of items per page.
+                Default: 50.
+
+        Returns:
+            PaperRepos: PaperRepos object.
+        """
+        params = self.__params(page, items_per_page)
+        timeout = None
+        if q is not None:
+            params["q"] = q
+        return self.__page(
+            self.http.get("/search/", params=params, timeout=timeout),
+            PaperRepos,
+        )
+
     @handler
     def paper_list(
         self,
@@ -243,6 +275,166 @@ def paper_result_list(
             Results,
         )
 
+    @handler
+    def repository_list(
+        self,
+        q: Optional[str] = None,
+        owner: Optional[str] = None,
+        name: Optional[str] = None,
+        stars: Optional[int] = None,
+        framework: Optional[str] = None,
+        page: int = 1,
+        items_per_page: int = 50,
+    ) -> Papers:
+        """Return a paginated list of repositories.
+
+        Args:
+            q (str, optional): Search all searchable fields.
+            owner (str, optional): Filter repositories by owner.
+            name (str, optional): Filter repositories by name.
+            stars (int, optional): Filter repositories by minimum number of
+                stars.
+            framework (str, optional): Filter repositories by framework.
+                Available values: tf, pytorch, mxnet, torch, caffe2, jax,
+                paddle, mindspore.
+            page (int): Desired page.
+            items_per_page (int): Desired number of items per page.
+                Default: 50.
+
+        Returns:
+            Repositories: Repositories object.
+        """
+        params = self.__params(page, items_per_page)
+
+        if q is not None:
+            params["q"] = q
+        if owner is not None:
+            params["owner"] = owner
+        if name is not None:
+            params["name"] = name
+        if stars is not None:
+            params["stars"] = str(stars)
+        if framework is not None:
+            params["framework"] = framework
+        return self.__page(
+            self.http.get("/repositories/", params=params),
+            Repositories,
+        )
+
+    @handler
+    def repository_owner_list(self, owner: str) -> Repositories:
+        """List all repositories for a specific repo owner.
+
+        Args:
+            owner (str): Repository owner.
+
+        Returns:
+            Repositories: Repositories object.
+        """
+        return self.__page(
+            self.http.get(f"/repositories/{owner}"),
+            Repositories,
+        )
+
+    @handler
+    def repository_get(self, owner: str, name: str) -> Repository:
+        """Return a repository by it's owner/name pair.
+
+        Args:
+            owner (str): Owner name.
+            name (str): Repository name.
+
+        Returns:
+            Repository: Repository object.
+        """
+        return Repository(**self.http.get(f"/repositories/{owner}/{name}/"))
+
+    @handler
+    def repository_paper_list(
+        self, owner: str, name: str, page: int = 1, items_per_page: int = 50
+    ) -> Papers:
+        """List all papers connected to the repository.
+
+        Args:
+            owner (str): Owner name.
+            name (str): Repository name.
+            page (int): Desired page.
+            items_per_page (int): Desired number of items per page.
+                Default: 50.
+
+        Returns:
+            Papers: Papers object.
+        """
+        params = self.__params(page, items_per_page)
+        return self.__page(
+            self.http.get(
+                f"/repositories/{owner}/{name}/papers/", params=params
+            ),
+            Papers,
+        )
+
+    @handler
+    def author_list(
+        self,
+        q: Optional[str] = None,
+        full_name: Optional[str] = None,
+        page: int = 1,
+        items_per_page: int = 50,
+    ) -> Authors:
+        """Return a paginated list of paper authors.
+
+        Args:
+            q (str, optional): Search all searchable fields.
+            full_name (str, optional): Filter authors by part of their full
+                name.
+            page (int): Desired page.
+            items_per_page (int): Desired number of items per page.
+                Default: 50.
+
+        Returns:
+            Repositories: Repositories object.
+        """
+        params = self.__params(page, items_per_page)
+
+        if q is not None:
+            params["q"] = q
+        if full_name is not None:
+            params["full_name"] = full_name
+        return self.__page(self.http.get("/authors/", params=params), Authors)
+
+    @handler
+    def author_get(self, author_id: str) -> Author:
+        """Return a specific author selected by its id.
+
+        Args:
+            author_id (str): Author id.
+
+        Returns:
+            Author: Author object.
+        """
+        return Author(**self.http.get(f"/authors/{author_id}/"))
+
+    @handler
+    def author_paper_list(
+        self, author_id: str, page: int = 1, items_per_page: int = 50
+    ) -> Papers:
+        """List all papers connected to the author.
+
+        Args:
+            author_id (str): Author id.
+            page (int): Desired page.
+            items_per_page (int): Desired number of items per page.
+                Default: 50.
+
+        Returns:
+            Papers: Papers object.
+        """
+        params = self.__params(page, items_per_page)
+        return self.__page(
+            self.http.get(f"/authors/{author_id}/papers/", params=params),
+            Papers,
+        )
+
     @handler
     def conference_list(
         self,

paperswithcode/models/__init__.py

@@ -4,6 +4,10 @@
     "Papers",
     "Repository",
     "Repositories",
+    "PaperRepo",
+    "PaperRepos",
+    "Author",
+    "Authors",
     "Conference",
     "Conferences",
     "Proceeding",
@@ -43,6 +47,8 @@
 from paperswithcode.models.page import Page
 from paperswithcode.models.paper import Paper, Papers
 from paperswithcode.models.repository import Repository, Repositories
+from paperswithcode.models.paper_repo import PaperRepo, PaperRepos
+from paperswithcode.models.author import Author, Authors
 from paperswithcode.models.conference import (
     Conference,
     Conferences,

paperswithcode/models/author.py

@@ -0,0 +1,30 @@
+from typing import List
+
+from tea_client.models import TeaClientModel
+
+from paperswithcode.models.page import Page
+
+
+class Author(TeaClientModel):
+    """Author object.
+
+    Attributes:
+        id (str): Author ID.
+        full_name (str, optional): Author full name.
+    """
+
+    id: str
+    full_name: str
+
+
+class Authors(Page):
+    """Object representing a paginated page of authors.
+
+    Attributes:
+        count (int): Number of elements matching the query.
+        next_page (int, optional): Number of the next page.
+        previous_page (int, optional): Number of the previous page.
+        results (List[Author]): List of authors on this page.
+    """
+
+    results: List[Author]

paperswithcode/models/paper_repo.py

@@ -0,0 +1,32 @@
+from typing import List, Optional
+
+from tea_client.models import TeaClientModel
+
+from paperswithcode.models.page import Page
+from paperswithcode.models.paper import Paper
+from paperswithcode.models.repository import Repository
+
+
+class PaperRepo(TeaClientModel):
+    """Paper <-> Repository object.
+
+    Attributes:
+        paper (Paper): Paper objects.
+        repository (Repository, optional): Repository object.
+    """
+
+    paper: Paper
+    repository: Optional[Repository]
+
+
+class PaperRepos(Page):
+    """Object representing a paginated page of paper<->repos.
+
+    Attributes:
+        count (int): Number of elements matching the query.
+        next_page (int, optional): Number of the next page.
+        previous_page (int, optional): Number of the previous page.
+        results (List[PaperRepo]): List of paper<->repos on this page.
+    """
+
+    results: List[PaperRepo]

paperswithcode/models/repository.py

@@ -1,4 +1,4 @@
-from typing import List
+from typing import List, Optional
 
 from tea_client.models import TeaClientModel
 
@@ -10,18 +10,23 @@ class Repository(TeaClientModel):
 
     Attributes:
         url (str): URL of the repository.
-        is_official (bool): Is this an official implementation of the paper.
+        owner (str): Repository owner.
+        name (str): Repository name.
         description (str): Repository description.
         stars (int): Number of repository stars.
         framework (str): Implementation framework (TensorFlow, PyTorch, MXNet,
-            Torch, Jax, Caffee2...)
+            Torch, Jax, Caffee2...).
+        is_official (bool): Is this an official implementation of the paper.
+            Available only when listing repositories for a specific paper.
     """
 
     url: str
-    is_official: bool
+    owner: str
+    name: str
     description: str
     stars: int
     framework: str
+    is_official: Optional[bool]
 
 
 class Repositories(Page):

paperswithcode/version.py

@@ -16,5 +16,5 @@ def __repr__(self):
         )
 
 
-version = Version(0, 2, 2)
+version = Version(0, 3, 0)
 __version__ = str(version)