README.rst

Retribute API
=============


Install (dev)
-------------

.. code-block: shell

  pip3 install --user virtualenv

  # create a Python3 virtualenv
  python3 -m virtualenv venv/

  # install dependencies
  venv/bin/pip3 install -e ".[dev]"

  # create and edit your env file
  cp env.sample .env

  # launch redis
  docker-compose up -d redis

  # launch the dev server
  venv/bin/python retribute_api/manage.py runserver

Querying the API
----------------

.. code-block: shell

  # list available lookups (sources)
  curl http://127.0.0.1:8000/v1/sources

  # list available providers)
  curl http://127.0.0.1:8000/v1/providers

  # retrieve data for a specifing profile
  curl http://127.0.0.1:8000/v1/search/webfinger:lila_bliblu@mastodon.opportunis.me