Package: h-api
h-apiTools and components for calling the H API.This package is not likely to be of use to youUnless you work for Hypothesis, then this package is not going to be very
useful to you. Feel free to have a poke about, but don't be surprised if it
doesn't make much sense.At the present time not only should you not use this package, our
authentication will also prevent it.UsageTo construct NDJSON for Bulk API calls:fromh_api.enumsimportViewTypefromh_api.bulk_apiimportCommandBuilder,BulkAPI,Executornd_json=BulkAPI.to_string([# It's your job to put the right commands here.# This also accepts a generatorCommandBuilder.configure(effective_user="acct:example@lms.hypothes.is",total_instructions=4,view=ViewType.BASIC),CommandBuilder.user.upsert({"username":"username","authority":"authority","display_name":"display_name","identities":[{"provider":"provider","provider_unique_id":"provider_unique_id"}],},"user_ref"),CommandBuilder.group.upsert({"name":"name","authority":"authority","authority_provided_id":"authority_provided_id"},"group_ref"),# These references here match those we assigned to the objects aboveCommandBuilder.group_membership.create("user_ref","group_ref")])# It's now your job to send this off to HTo accept and process an NDJSON request like the above:classMyExectutor(Executor):defexecute_batch(self,command_type,data_type,default_config,batch):"""Implement your insertion logic here and return Report Objects"""rows=BulkAPI.from_byte_stream(http_streaming_body,executor=MyExectutor())ifrows:# Turn each row into JSON and return to your caller# You have to do thisSetting up Your h-api Development EnvironmentFirst you'll need to install:Git.
On Ubuntu:sudo apt install git, on macOS:brew install git.GNU Make.
This is probably already installed, runmake --versionto check.pyenv.
Follow the instructions in pyenv's README to install it.
TheHomebrewmethod works best on macOS.
TheBasic GitHub Checkoutmethod works best on Ubuntu.
Youdon'tneed to set up pyenv's shell integration ("shims"), you canuse pyenv without shims.Then to set up your development environment:git clone https://github.com/hypothesis/h-api.git
cd h-api
make helpReleasing a New Version of the ProjectFirst, to get PyPI publishing working you need to go to:https://github.com/organizations/hypothesis/settings/secrets/actions/PYPI_TOKENand add h-api to thePYPI_TOKENsecret's selected
repositories.Now that the h-api project has access to thePYPI_TOKENsecret
you can release a new version by justcreating a new GitHub release.
Publishing a new GitHub release will automatically triggera GitHub Actions workflowthat will build the new version of your Python package and upload it tohttps://pypi.org/project/h-api.Changing the Project's Python VersionsTo change what versions of Python the project uses:Change the Python versions in thecookiecutter.jsonfile. For example:"python_versions":"3.10.4, 3.9.12",Re-run the cookiecutter template:make templateCommit everything to git and send a pull requestChanging the Project's Python DependenciesTo change the production dependencies in thesetup.cfgfile:Change the dependencies in the.cookiecutter/includes/setuptools/install_requiresfile.
If this file doesn't exist yet create it and add some dependencies to it.
For example:pyramid
sqlalchemy
celeryRe-run the cookiecutter template:make templateCommit everything to git and send a pull requestTo change the project's formatting, linting and test dependencies:Change the dependencies in the.cookiecutter/includes/tox/depsfile.
If this file doesn't exist yet create it and add some dependencies to it.
Use tox'sfactor-conditional settingsto limit which environment(s) each dependency is used in.
For example:lint: flake8,
format: autopep8,
lint,tests: pytest-faker,Re-run the cookiecutter template:make templateCommit everything to git and send a pull request