https://github.com/boxingoctopuscreative/giteo

Giteo: Git.io URL Shortener CLI Client
https://github.com/boxingoctopuscreative/giteo

command-line command-line-tool git-io github python python3 url-shortener

Last synced: 27 days ago
JSON representation

Giteo: Git.io URL Shortener CLI Client

• Host: GitHub
• URL: https://github.com/boxingoctopuscreative/giteo
• Owner: BoxingOctopusCreative
• License: apache-2.0
• Created: 2021-04-19T01:27:16.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-02-23T19:42:45.000Z (over 3 years ago)
• Last Synced: 2025-06-20T23:04:56.680Z (12 months ago)
• Topics: command-line, command-line-tool, git-io, github, python, python3, url-shortener
• Language: Python
• Homepage:
• Size: 58.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Giteo

[![GitHub version](https://badge.fury.io/gh/BoxingOctopus%2Fgiteo.svg)](https://badge.fury.io/gh/BoxingOctopus%2Fgiteo)

[![PyPI version](https://badge.fury.io/py/giteo.svg)](https://badge.fury.io/py/giteo)

![PyPI - Wheel](https://img.shields.io/pypi/wheel/giteo)

![PyPI - Implementation](https://img.shields.io/pypi/implementation/giteo)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/giteo)

![Docker Image Version (latest semver)](https://img.shields.io/docker/v/tuxotaku/giteo)

![PyPI - License](https://img.shields.io/pypi/l/giteo)

![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/tuxotaku/giteo)

[![Documentation Status](https://readthedocs.org/projects/giteo/badge/?version=latest)](https://giteo.readthedocs.io/en/latest/?badge=latest)

## Table of Contents

- [About](#about)

- [Getting Started](#getting_started)

- [Usage](#usage)

- [Contributing](../CONTRIBUTING.md)

## About 

Giteo is a CLI-based URL shortener written in Python which uses GitHub's [git.io](https://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  --code `

### Docker

`docker run --rm TuxOtaku/giteo:latest --url  --code `