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 details)

Uploaded Source

Built Distribution

shtl_ink_api-0.0.20-py3-none-any.whl (2.0 kB view details)

Uploaded Python 3

File details

Details for the file shtl-ink-api-0.0.20.tar.gz.

File metadata

  • Download URL: shtl-ink-api-0.0.20.tar.gz
  • Upload date:
  • Size: 2.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for shtl-ink-api-0.0.20.tar.gz
Algorithm Hash digest
SHA256 59dac760d37d08400b36577eedb4b01b7d6b7a7766733e9443c39a06ae940aca
MD5 ab3324e3fc6450210a7bde9f7ea4f342
BLAKE2b-256 240b6653c50917abbc5d3a19f7680347cffbea8749332990be7c852a3fe26017

See more details on using hashes here.

File details

Details for the file shtl_ink_api-0.0.20-py3-none-any.whl.

File metadata

File hashes

Hashes for shtl_ink_api-0.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 645d06424d58e123dfbd2a8f47a25a77a376e52a505a577bfb1ec9c8821c52fc
MD5 64c479e938a67bcbd9cf545896ce5ac6
BLAKE2b-256 75029c01834bd408edb4f0d46d3f8e5b97b92013c0cf805a87c7e1f648dafae9

See more details on using hashes here.

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