README.md

About PyUXS

PyUXS (Python URLs Expander & Shortener) is a CLI tools for shortening or expanding URLs. Shortener, as the name suggests, is a service to help reduce the length of the URL so that it can be shared easily on other platform and as for Expander, is a service to expand the shortended URL, it also help user to determine whether the destination of a shortened URL is save or not to visit.

PyUXS uses "TinyURL", "Chilp.it", "Da.gd" for its shortener services. This is because the API intergration for these shortener is way easier and doesn't require any Key token to use.

(back to top)

Getting Started

This is an instructions on setting up this tool locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Necessary tools and libraries to have:

• Python >= 3.9 and < 3.10
• Pip
• virtualenv
• pyshorteners
• PyInquirer
• colorama
• termcolor
• pyfiglet

How to Run

Below is an example of how you can setup this project within your local environtment.

1. Clone the repo

   git clone https://github.com/farithadnan/PyUXS.git

2. Create new virtual environtment within PyUXS folder

   virtualenv -p python3 virtual_env_name

3. Activate virtual environtment

   . virtual_env_name/Scripts/activate 

4. Install all the require libraries via requirement.txt

   pip install -r requirement.txt
   

5. Done, now you can start running the main.py like any other python script

(back to top)

References

References that being used:

1. Libraries Related
   • How to use virtual env
   • How to use URL shortener with Python
   • shortener library
   • Project Example
   • How to convert Python Script into Exe

(back to top)