Skip to content

Latest commit

 

History

History
142 lines (103 loc) · 4.44 KB

README.md

File metadata and controls

142 lines (103 loc) · 4.44 KB
Raw

s2cholar

Client for the new Semantic Scholar API.

We used the Swagger Codegen project to generate the initial version of this package, which was then modified by the contributors.

Details of the Swagger Codegen used:

  • API version: 1.0
  • Package version: 0.1.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Announcement

This project is active and under development. Everyone is more than welcome to help and contribute.

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/luizvbo/s2cholar.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/luizvbo/s2cholar.git)

Then import the package:

import s2cholar

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import s2cholar

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import s2cholar
from s2cholar.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = s2cholar.AuthorApi(s2cholar.ApiClient(configuration))
author_id = '145872832' # str

try:
    # Details about an author
    api_response = api_instance.get_graph_get_author(author_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorApi->get_graph_get_author: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.semanticscholar.org/graph/v1

Class Method HTTP request Description
AuthorApi get_graph_get_author GET /author/{author_id} Details about an author
AuthorApi get_graph_get_author_papers GET /author/{author_id}/papers Details about an author's papers
PaperApi get_paper GET /paper/{paper_id} Details about a paper
PaperApi get_paper_authors GET /paper/{paper_id}/authors Details about a paper's authors
PaperApi get_paper_citations GET /paper/{paper_id}/citations Details about a paper's citations
PaperApi get_paper_references GET /paper/{paper_id}/references Details about a paper's references
PaperApi get_paper_search GET /paper/search Search for papers by keyword

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

Luiz Otavio Vilas Boas Oliveira

Contribution

Contributions are more than welcome to this package.

Commit Messages

In order to keep our git log clean, use the tags below in your commit messages (adapted from the numpy workflow):

  • API: an (incompatible) API change
  • BUG: bug fix
  • CICD: changes to the CI/CD
  • DEP: deprecate something, or remove a deprecated object
  • DOC: documentation
  • ENH: enhancement
  • MAINT: maintenance commit (refactoring, typos, etc.)
  • REV: revert an earlier commit
  • STY: style fix (whitespace, PEP8)
  • TST: addition or modification of tests