Feat: URL Shortener Project

[justinjohnson-dev]

Type of change

• [x] Added new project
• [ ] Bug fix
• [x] New features
• [x] Enhanced documentation

Changes proposed in this pull request

• Project name : URL Shortener

Short description :

URL Shortener Project

The URL Shortener project is a Python-based application designed to create shortened versions of long URLs, making them easier to share and manage. The project leverages Pydantic for data validation and type checking, ensuring robust input handling and error management. It uses the pyshorteners library to interface with various URL shortening services, providing flexibility in choosing different providers.

Key Features

• User Input Validation: Ensures that only valid URLs are processed using Pydantic's HttpUrl type for strict URL validation.
• Dynamic Shortener Selection: Allows for easy switching between different URL shortening services by configuring the shortener instance.
• Robust Error Handling: Catches and handles various exceptions, such as parsing errors and validation errors, to provide meaningful error messages to the user.
• Command-Line Interface: Provides a simple CLI for users to input their long URLs and receive shortened versions in return.

Components

• Model:

  • UrlShortenerValidation: A Pydantic model that validates the input URL.

• Service:

  • URLShortener: A class that encapsulates the URL shortening logic, using pyshorteners to shorten the URLs and handling potential errors.

• Main Script:

  • Contains the logic to accept user input, validate it, and use the URLShortener service to generate and display the shortened URL.

Example Usage

$ python app/main.py
Enter the URL you want to shorten: https://example.com
Shortened URL: http://tinyurl.com/shortened_url

Technology Stack Python: The core programming language. Pydantic: For data validation and type enforcement. pyshorteners: To interface with URL shortening services.

This project is ideal for demonstrating the integration of third-party services in Python, data validation using Pydantic, and implementing a simple yet effective CLI application.

Checklist

• [x] The code is Python 3 compatible
• [x] I have added relevant comments in my file to make code understandable
• [x] I have added my project in a folder which includes all the necessary files

[github-actions[bot]]

Greetings! This is an automated message from GitHub Actions. :robot: Your pull request has been received and is awaiting for a review by the repository owner or a maintainer. This may take some time, so please be patient. While you wait, you can continue to work on other issues or pull requests, or explore the project further. Or you can simply relax and enjoy your day. Thank you for your contribution to this project! You are awesome! :star:

[justinjohnson-dev]

@Mrinank-Bhowmick

[Mrinank-Bhowmick]

Great work @justinjohnson-dev 🚀