Giter Club home page Giter Club logo

pyhypothesis's Introduction

pyhypothesis - A python API client for hypothes.is

The provided client is a very simple API client to hypothes.is that supports all api calls as of march 2017 except the create new user call.

License

The project is licensed under the MIT license - see LICENSE.txt

TODO

  • Implement the "Create a new user" API call and related authentication
  • keep up to date with https://h.readthedocs.io/en/latest/api/
  • generate sphinx docs
  • The code is tested manually but unit tests are needed

Contributing

See CONTRIBUTING.rst

Examples

The client supports only api token authentication and a new client instance is initialized as follows:

from pyhypothesis.api import HypoClient
client = HypoClient("<api-token-here>")

After initializing the client requests can be made like so:

result1 = client.fetch_annotation('U62d1A-2Edd82gOoVMICqA')
result2 = client.update_annotation('U62d1A-2Edd82gOoVMICqA', text="test 123")
result3 = client.delete_annotation('U62d1A-2Edd82gOoVMICqA')
result4 = client.search_annotations(
    group="4PvgDpPS",
    user="[email protected]",
    tags=["corrections"],
    url='https://random-demo-website.com/arbitrary_page.html'
)
user_profile = client.get_user_profile()

pyhypothesis's People

Contributors

strongholder avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.