Giteo

Table of Contents

• About
• Getting Started
• Usage
• Contributing

About

Giteo is a CLI-based URL shortener written in Python which uses GitHub's git.io URL shortening service.

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

• Python 3.7+
• Pipenv
• Docker (Optional)

Development Setup

1. Fork this repo
2. Set up your Pipenv environment (pipenv install)
3. Set up your Docker environment (docker build -t giteo:latest .) (Optional)

Installing

Bare Metal Install

pip install giteo

Docker Install

docker pull TuxOtaku/giteo:latest

Usage

Bare Metal

giteo --url <url_to_be_shortened> --code <shortened_url_suffix>

Docker

docker run --rm TuxOtaku/giteo:latest --url <url_to_be_shortened> --code <shortened_url_suffix>