docs: add e2e example

Author: kkweon

client_example_test.go

@@ -0,0 +1,22 @@
+package paperswithcode_go_test
+
+import (
+	"fmt"
+
+	paperswithcode_go "github.com/codingpot/paperswithcode-go"
+)
+
+func Example() {
+	c := paperswithcode_go.NewClient()
+	papers, _ := c.PaperList(paperswithcode_go.PaperListParamsDefault())
+	fmt.Println(len(papers.Results))
+
+	gan, _ := c.PaperGet(paperswithcode_go.GetPaperIDFromPaperTitle("Generative Adversarial Networks"))
+	fmt.Println(gan.Title)
+	fmt.Println(gan.Authors)
+
+	// Output:
+	// 50
+	// Generative Adversarial Networks
+	// [Ian J. Goodfellow Jean Pouget-Abadie Mehdi Mirza Bing Xu David Warde-Farley Sherjil Ozair Aaron Courville Yoshua Bengio]
+}

models/paper_list_result.go

@@ -1,5 +1,7 @@
 package models
 
+import "fmt"
+
 // PaperListResult is the result of PaperListResult() function.
 type PaperListResult struct {
 	Count    int64                 `json:"count"`
@@ -8,6 +10,8 @@ type PaperListResult struct {
 	Results  []PaperListResultItem `json:"results"`
 }
 
+var _ fmt.Stringer = (*PaperListResultItem)(nil)
+
 type PaperListResultItem struct {
 	ID               string         `json:"id"`
 	ArxivID          *string        `json:"arxiv_id"`
@@ -23,3 +27,8 @@ type PaperListResultItem struct {
 	ConferenceURLPDF *string        `json:"conference_url_pdf"`
 	Proceeding       *string        `json:"proceeding"`
 }
+
+func (p PaperListResultItem) String() string {
+	return fmt.Sprintf("ID: %s ArxivID: %v NipsID: %v, URLAbs: %s, URLPDF: %s Title: %s Authors: %s",
+		p.ID, p.ArxivID, p.NipsID, p.URLAbs, p.URLPDF, p.Title, p.Authors)
+}