Metadata-Version: 2.1
Name: shtl-ink-api
Version: 0.0.18
Summary: Python URL Shortener
Home-page: https://github.com/mskymoore/url_shortener
Author: Sky Moore
Author-email: mskymoore@gmail.com
License: MIT license
Keywords: url,url_shortener,api
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
Requires-Dist: autopep8 (==1.6.0)
Requires-Dist: build (==0.8.0)
Requires-Dist: fastapi (==0.78.0)
Requires-Dist: jinja2 (==3.1.2)
Requires-Dist: multipart (==0.2.4)
Requires-Dist: psycopg2-binary (==2.9.3)
Requires-Dist: pytest (==7.1.2)
Requires-Dist: pytest-cov (==3.0.0)
Requires-Dist: python-multipart (==0.0.5)
Requires-Dist: requests (==2.28.0)
Requires-Dist: setuptools-rust (==1.3.0)
Requires-Dist: sqlalchemy (==1.4)
Requires-Dist: sqlalchemy-serializer (==1.4.1)
Requires-Dist: uvicorn[standard] (==0.17.6)
Requires-Dist: virtualenv (==20.14.1)

# shtl.ink api
**URL Shortener built with Python and FastAPI**

[github repository](https://github.com/mskymoore/url_shortener)

## 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
```console
pip install -r requirements.txt
python -m build
```
## Run Local

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

## Docker Compose
  See docker-compose.yml

## Build Docker
```console
docker build -t skymoore/shtl-ink-api .
```

## Run Docker

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

