Skip to main content

Python URL Shortener

Project description

shtl.ink api

URL Shortener built with Python and FastAPI

github repository

Read API Docs

  1. Run App
  2. Navigate to http://localhost:8000/docs or http://localhost:8000/redoc

Configure environment variables

# requires postgres database
export BASE_URL=http://localhost:8000
# where to redirect / to
export ROOT_REDIRECT_URL=http://shtl.ink
export DB_HOST=abcd
export DB_NAME=abcd
export DB_USER=abcd
export DB_PASS=abcd

Build Local

pip install -r requirements.txt
python -m build

Run Local

pip install shtl-ink-api
uvicorn shtl_ink_api.app:app

Docker Compose

See docker-compose.yml

Build Docker

docker build -t skymoore/shtl-ink-api .

Run Docker

docker pull skymoore/shtl-ink-api
docker run --rm -it  -p 8000:8000/tcp skymoore/shtl-ink-api:latest

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

shtl-ink-api-0.0.20.tar.gz (2.1 kB view hashes)

Uploaded Source

Built Distribution

shtl_ink_api-0.0.20-py3-none-any.whl (2.0 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