Skip to main content

API Server to serve random gifs with support for public suggestions

Project description

Ugoki API Server

Ugoki is a simple server for storing categorized gifs where anyone can suggest gifs but the owner can approve them only.

Usage

Production

To install the last stable version, simply run

$ pip install ugoki

To start a ugoki API server, run ugoki-prod with correct arguments.

$ ugoki-prod -h
usage: ugoki-prod [-h] [-p PORT] [-H HOST] STORAGE SERVE_ROOT AUTH_USER AUTH_PASSWORD DB_STRING

positional arguments:
  STORAGE               Path to store gifs
  SERVE_ROOT            Root where the gifs are served by the web server
  AUTH_USER             Username for API
  AUTH_PASSWORD         Password for API
  DB_STRING             String to connect to database. (e.g. sqlite:///ugoki.sqlite)

optional arguments:
  -h, --help            show this help message and exit
  -p PORT, --port PORT  Port to listen on. Default: 8000
  -H HOST, --host HOST  Host to listen for. Default: 127.0.0.1

Development

  • git clone https://gitlab.com/ceda_ei/ugoki.git/
  • cd ugoki
  • poetry install
  • poetry shell
  • ugoki-dev

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ugoki-1.0.3.tar.gz (17.1 kB view hashes)

Uploaded Source

Built Distribution

ugoki-1.0.3-py3-none-any.whl (18.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page