Git Product home page Git Product logo

py-shortly's Introduction

py-shortly: URL Shortener Service

This project is a URL shortener service implemented in Python utilizing FastAPI and SQLAlchemy. Specifically crafted for educational purposes and experimentation.

Features

  • URL Shortening: The service provides a way to shorten URLs. The shorten function takes a UrlRequest object (which contains the original URL and the user ID) and returns a shortened URL.

  • URL Retrieval: The service also provides a way to retrieve the original URL from the shortened URL. The get_long_url function takes a shortened URL ID and returns the original URL.

Usage

To use the URL shortener service, you need to call the shorten function with a UrlRequest object. The function will return a Url object with the shortened URL.

To retrieve the original URL, you need to call the get_long_url function with the ID of the shortened URL. The function will return the original URL.

Dependencies

  • FastAPI: A modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
  • SQLAlchemy: The Python SQL Toolkit and Object-Relational Mapper that gives application developers the full power and flexibility of SQL.

TO-DOS:

  • Unit tests
  • Authorization (roles)
  • Caching
  • Dockerize
  • Workflow

py-shortly's People

Contributors

brunohaf avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.