Metadata-Version: 2.1
Name: giteo
Version: 1.0.0
Summary: Giteo: A CLI Client for GitHub's Git.io URL Shortener
Home-page: https://github.com/BoxingOctopus/giteo
Author: Ryan Draga
Author-email: ryan.draga@boxingoctop.us
License: Apache-2.0
Download-URL: https://github.com/BoxingOctopus/giteo/archive/1.0.0.tar.gz
Description: # Giteo
        
        ## Table of Contents
        
        - [About](#about)
        - [Getting Started](#getting_started)
        - [Usage](#usage)
        - [Contributing](../CONTRIBUTING.md)
        
        ## About <a name = "about"></a>
        
        Giteo is a CLI-based URL shortener written in Python which uses GitHub's [git.io](https://git.io) URL shortening service.
        
        ## Getting Started <a name = "getting_started"></a>
        
        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 <a name = "usage"></a>
        
        ### 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>`
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Description-Content-Type: text/markdown
