https://github.com/embo-press/hypothepy

A lightweight Python API for hypothes.is
https://github.com/embo-press/hypothepy

Last synced: 3 months ago
JSON representation

A lightweight Python API for hypothes.is

• Host: GitHub
• URL: https://github.com/embo-press/hypothepy
• Owner: embo-press
• License: mit
• Created: 2019-08-28T06:41:32.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T21:30:10.000Z (almost 2 years ago)
• Last Synced: 2024-07-05T16:30:40.580Z (4 months ago)
• Language: Python
• Homepage: https://hypothepy.readthedocs.io
• Size: 72.3 KB
• Stars: 10
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - embo-press/hypothepy - A lightweight Python API for hypothes.is (others)

README

        
.. image:: docs/logos/embopress.png

        :width: 200

        :target: https://www.embopress.org/

=========

Hypothepy

=========

.. image:: https://img.shields.io/pypi/v/hypothepy.svg

        :target: https://pypi.python.org/pypi/hypothepy

.. image:: https://img.shields.io/travis/embo-press/hypothepy.svg

        :target: https://travis-ci.org/embo-press/hypothepy

.. image:: https://readthedocs.org/projects/hypothepy/badge/?version=latest

        :target: https://hypothepy.readthedocs.io/en/latest/?badge=latest

        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/embo-press/hypothepy/shield.svg

     :target: https://pyup.io/repos/github/embo-press/hypothepy/

     :alt: Updates

A lightweight Python API for `Hypothes.is `_

* Free software: MIT license

* Documentation: https://hypothepy.readthedocs.io

* Check the official hypothes.is documentation:

  - https://h.readthedocs.io/en/latest

  - https://h.readthedocs.io/en/latest/api-reference

Features

--------

* Light Python interface for all the REST endpoints available.

  - API parameters are simple native python types

  - API calls just return a `requests.Response` object

  - provides handy helpers

* Python 3.6+

* Only `version 1 (stable)`_ implemented (for the moment)

* Only `APIKey Authentication`_ implemented (for the moment)

* Command line interface (cooming soon)

.. _version 1 (stable): https://h.readthedocs.io/en/latest/api-reference/#section/Hypothesis-API/Versions

.. _APIKey Authentication: https://h.readthedocs.io/en/latest/api-reference/#section/Authentication