python3 flask based python-url-shortener microservice.

Last update: Oct 18, 2021

Overview

python-url-shortener

This repository is for managing all public/private entity specific api endpoints for an organisation. In this case we have entity as URL shortener

Project Structure

The basic project structure is as follows:

root/
 |-- app
 |   |-- controllers/
 |   |   |-- __init__.py
 |   |   |-- url_shortener_controller.py
 |   |-- services/
 |   |   |-- __init__.py
 |   |   |-- url_shortener_service.py
 |   |-- schemas/
 |   |   |-- __init__.py
 |   |   |-- url_shortener_schema.py
 |   |-- utilities/
 |   |   |-- __init__.py
 |   |   |-- url_shortener_utility.py
 |   |-- tests/
 |   |   |-- __init__.py
 |   |   |-- test_url_shortener_controller.py
 |   |   |-- test_url_shortener_utility.py
 |   |-- config.py
 |   |-- errors.py
 |   |-- routes.py
 |   |-- __init__.py
 |   build.sh
 |   logging.yaml
 |   setup.py
 |   README.md

Synopsis

There are two API endpoints exposed as part of this app
1. /url/encode
2. /url/decode

/url/encode:  Will shorten a valid URL and returns a shorten URL(JSON) also 
put origianl, shorten url in cache(We are using flask_caching for storage).

/url/decode:  Will return a valid URL original URL(JSON) for a given shorten 
url from cache(We are using flask_caching for storage).

For request/response structure please reffer 
Swagger URl after successful buld & run step.

Requirements

python 3.9
Flask 2.0.2
marshmallow 3.12.2
flask_caching
Werkzeug 2.0.2

for detiled requirement please reffer setup.py

Quick Start Setup

Run Setup.

This will create virtualenv and install all required packages and will allow you to run the app from anywhere on your machine.

$> cd the-shortest-url-1-uvpyns
$> ./build.sh

Run the tests

$> cd the-shortest-url-1-uvpyns
$> pytest

Running Locally

API can be executed as follows:

$> cd the-shortest-url-1-uvpyns
$> python api_gateway.py

Navigate to the posted URL in your terminal to be greeted with Swagger, where you can run the API endpoints.

python3 flask based python-url-shortener microservice.

Related tags

Overview

python-url-shortener

Project Structure

Synopsis

Requirements

Quick Start Setup

Run Setup.

Run the tests

Running Locally

Owner

Asutosh Parida

C++ library for urlencode.

find all the URL of a site with a specific Regex

A tool to manage the base URL of the Python package index.

a url shortener project from semicolonworld

🌐 URL parsing and manipulation made easy.

a little project to make custom discord invites over a url

Customizable URL shortener written in Python3 for sniffing and spoofing

🔗 Generate Phishing URLs 🔗

Extract countries, regions and cities from a URL or text

encurtador de links feito com python

URL Shortener in Flask - Web service using Flask framework for Shortener URLs

Simple Version of ouo.io. shorten any link on the web easily

Fast pattern fetcher, Takes a URLs list and outputs the URLs which contains the parameters according to the specified pattern.

This is a no-bullshit file hosting and URL shortening service that also runs 0x0.st. Use with uWSGI.

A simple URL shortener app using Python AWS Chalice, AWS Lambda and AWS Dynamodb.

A friendly library for parsing HTTP request arguments, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, webapp2, Falcon, and aiohttp.

Python implementation for generating Tiny URL- and bit.ly-like URLs.

Shorten-Link - Make shorten URL with Cuttly API

A URL builder for genius :D

hugeURLer 是一个基于 Python 和 GitHub action 的短链接服务