{"id":30240410,"url":"https://github.com/hypothesis/h-api","last_synced_at":"2025-08-15T04:38:33.821Z","repository":{"id":37927267,"uuid":"256183341","full_name":"hypothesis/h-api","owner":"hypothesis","description":"Tools and components for calling the H API","archived":false,"fork":false,"pushed_at":"2025-06-13T14:48:04.000Z","size":149,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-07-15T18:11:08.736Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hypothesis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-04-16T10:33:15.000Z","updated_at":"2025-06-13T14:48:06.000Z","dependencies_parsed_at":"2023-02-13T21:40:18.678Z","dependency_job_id":"aecc981f-8c5f-466a-b436-8520e25a3d6f","html_url":"https://github.com/hypothesis/h-api","commit_stats":{"total_commits":30,"total_committers":4,"mean_commits":7.5,"dds":0.3666666666666667,"last_synced_commit":"181866a6e452dd45dc7cdcae777bba14fe1be79c"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/hypothesis/h-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Fh-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Fh-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Fh-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Fh-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hypothesis","download_url":"https://codeload.github.com/hypothesis/h-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Fh-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270524432,"owners_count":24600195,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-15T04:38:26.480Z","updated_at":"2025-08-15T04:38:33.812Z","avatar_url":"https://github.com/hypothesis.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://github.com/hypothesis/h-api/actions/workflows/ci.yml?query=branch%3Amain\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/hypothesis/h-api/ci.yml?branch=main\"\u003e\u003c/a\u003e\n\u003ca href=\"https://pypi.org/project/h-api\"\u003e\u003cimg src=\"https://img.shields.io/pypi/v/h-api\"\u003e\u003c/a\u003e\n\u003ca\u003e\u003cimg src=\"https://img.shields.io/badge/python-3.12 | 3.11 | 3.10 | 3.9-success\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/hypothesis/h-api/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-BSD--2--Clause-success\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/hypothesis/cookiecutters/tree/main/pypackage\"\u003e\u003cimg src=\"https://img.shields.io/badge/cookiecutter-pypackage-success\"\u003e\u003c/a\u003e\n\u003ca href=\"https://black.readthedocs.io/en/stable/\"\u003e\u003cimg src=\"https://img.shields.io/badge/code%20style-black-000000\"\u003e\u003c/a\u003e\n\n# h-api\n\nTools and components for calling the H API.\n\nThis package is not likely to be of use to you\n----------------------------------------------\n\nUnless you work for Hypothesis, then this package is not going to be very\nuseful to you. Feel free to have a poke about, but don't be surprised if it\ndoesn't make much sense.\n\nAt the present time not only should you not use this package, our \nauthentication will also prevent it.\n\nUsage\n-----\n\nTo construct NDJSON for Bulk API calls:\n\n```python\nfrom h_api.enums import ViewType\n\nfrom h_api.bulk_api import CommandBuilder, BulkAPI, Executor\n\nnd_json = BulkAPI.to_string([\n    # It's your job to put the right commands here. \n    # This also accepts a generator\n\n    CommandBuilder.configure(\n        effective_user=\"acct:example@lms.hypothes.is\", \n        total_instructions=4, \n        view=ViewType.BASIC),\n\n    CommandBuilder.user.upsert({\n        \"username\": \"username\",\n        \"authority\": \"authority\",\n        \"display_name\": \"display_name\",\n        \"identities\": [{\n            \"provider\": \"provider\",\n            \"provider_unique_id\": \"provider_unique_id\"\n        }],\n    }, \"user_ref\"),\n\n    CommandBuilder.group.upsert({\n        \"name\": \"name\",\n        \"authority\": \"authority\",\n        \"authority_provided_id\": \"authority_provided_id\"\n    }, \"group_ref\"),\n    \n    # These references here match those we assigned to the objects above\n    CommandBuilder.group_membership.create(\"user_ref\", \"group_ref\")\n])\n\n# It's now your job to send this off to H\n```\n\nTo accept and process an NDJSON request like the above:\n```python\nclass MyExectutor(Executor):\n    def execute_batch(self, command_type, data_type, default_config, batch):\n        \"\"\"Implement your insertion logic here and return Report Objects\"\"\"\n        \nrows = BulkAPI.from_byte_stream(http_streaming_body, executor=MyExectutor())\n\nif rows:\n    # Turn each row into JSON and return to your caller\n    # You have to do this\n```\n\n## Setting up Your h-api Development Environment\n\nFirst you'll need to install:\n\n* [Git](https://git-scm.com/).\n  On Ubuntu: `sudo apt install git`, on macOS: `brew install git`.\n* [GNU Make](https://www.gnu.org/software/make/).\n  This is probably already installed, run `make --version` to check.\n* [pyenv](https://github.com/pyenv/pyenv).\n  Follow the instructions in pyenv's README to install it.\n  The **Homebrew** method works best on macOS.\n  The **Basic GitHub Checkout** method works best on Ubuntu.\n  You _don't_ need to set up pyenv's shell integration (\"shims\"), you can\n  [use pyenv without shims](https://github.com/pyenv/pyenv#using-pyenv-without-shims).\n\nThen to set up your development environment:\n\n```terminal\ngit clone https://github.com/hypothesis/h-api.git\ncd h-api\nmake help\n```\n\n## Releasing a New Version of the Project\n\n1. First, to get PyPI publishing working you need to go to:\n   \u003chttps://github.com/organizations/hypothesis/settings/secrets/actions/PYPI_TOKEN\u003e\n   and add h-api to the `PYPI_TOKEN` secret's selected\n   repositories.\n\n2. Now that the h-api project has access to the `PYPI_TOKEN` secret\n   you can release a new version by just [creating a new GitHub release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository).\n   Publishing a new GitHub release will automatically trigger\n   [a GitHub Actions workflow](.github/workflows/pypi.yml)\n   that will build the new version of your Python package and upload it to\n   \u003chttps://pypi.org/project/h-api\u003e.\n\n## Changing the Project's Python Versions\n\nTo change what versions of Python the project uses:\n\n1. Change the Python versions in the\n   [cookiecutter.json](.cookiecutter/cookiecutter.json) file. For example:\n\n   ```json\n   \"python_versions\": \"3.10.4, 3.9.12\",\n   ```\n\n2. Re-run the cookiecutter template:\n\n   ```terminal\n   make template\n   ```\n\n3. Commit everything to git and send a pull request\n\n## Changing the Project's Python Dependencies\n\nTo change the production dependencies in the `setup.cfg` file:\n\n1. Change the dependencies in the [`.cookiecutter/includes/setuptools/install_requires`](.cookiecutter/includes/setuptools/install_requires) file.\n   If this file doesn't exist yet create it and add some dependencies to it.\n   For example:\n\n   ```\n   pyramid\n   sqlalchemy\n   celery\n   ```\n\n2. Re-run the cookiecutter template:\n\n   ```terminal\n   make template\n   ```\n\n3. Commit everything to git and send a pull request\n\nTo change the project's formatting, linting and test dependencies:\n\n1. Change the dependencies in the [`.cookiecutter/includes/tox/deps`](.cookiecutter/includes/tox/deps) file.\n   If this file doesn't exist yet create it and add some dependencies to it.\n   Use tox's [factor-conditional settings](https://tox.wiki/en/latest/config.html#factors-and-factor-conditional-settings)\n   to limit which environment(s) each dependency is used in.\n   For example:\n\n   ```\n   lint: flake8,\n   format: autopep8,\n   lint,tests: pytest-faker,\n   ```\n\n2. Re-run the cookiecutter template:\n\n   ```terminal\n   make template\n   ```\n\n3. Commit everything to git and send a pull request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypothesis%2Fh-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhypothesis%2Fh-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypothesis%2Fh-api/lists"}