Simple API client for SocialHub's API.
- clone the repo
$ git clone email@example.com:Uberspace/socialhub.git $ cd socialhub $ python3 -m venv venv $ source venv/bin/activate
- install dependencies and commit-hooks
$ make devsetup pip install -r requirements.txt -r requirements.dev.txt Collecting requests==2.23.* (from -r requirements.txt (line 1)) Using cached https://files.pythonhosted.org/packages/1a/70/1935c770cb3be6e3a8b78ced23d7e0f3b187f5cbfab4749523ed65d7c9b1/requests-2.23.0-py2.py3-none-any.whl (...) Running setup.py install for pyyaml ... done Running setup.py install for distlib ... done Running setup.py install for wrapt ... done Successfully installed appdirs-1.4.3 aspy.yaml-1.3.0 (...) pre-commit install --overwrite --install-hooks pre-commit installed at .git/hooks/pre-commit
We're using py.test. You can run all of the tests on all supported python
make test. If you don't have that much time, try
make quicktest, which runs
The tests make use of vcrpy, which records all requests to the SocialHub APIs
socialhub/cassette directory. As long as you don't add any,
this enables you to run the existing tests without having access to these
To delete the recorded data and get fresh version, run the following command. Inspect the resuling cassettes for secret leaks.
$ make recordvcr
Releasing a new version
Assuming you have been handed the required credentials, a new version can be released as follows.
- adapt the version in
setup.py, according to
- commit this change as
- tag the resulting commit as
- push the new tag as well as the
- update the package on PyPI:
$ make build $ make upload
This API client is not developed, endorsed or validated by SocialHub or its developer maloon GmbH. The name "SocialHub" is owned by maloon GmbH, not by the authors of this library.