luanspaceship 1.0.2

Table of Contents

1. About The Project
2. Installation
   • Prerequisites
   • Installing
3. Usage
4. License
5. Contact
6. Acknowledgments

About The Project

Luanspaceship is a really simple Command-Line Interface written in Python3 that prints an ASCII spaceship in function of a length given via flag. Aditionally, output can be copied into clipboard, change colors of spaceship printed (only for console visual purposes) and a couple of others functions.

This is a little project written for Science & Commit // Workshop 2022.

(back to top)

Installation

This simple project needs a few Python3 packages to run properly.

Prerequisites

• pip (if you have already installed pip you can ignore this subsection)

  If for some reason you have not installed pip with Python3 (which would be... weird) try this:

  • Download the script, from https://bootstrap.pypa.io/get-pip.py

  • Open a terminal/command prompt, cd to the folder containing the get-pip.py file and run

    On Linux/MacOS:

    python3 get-pip.py
    

    On Windows:

    py get-pip.py
    

    For more options you can also check official Python 'pip' documentation.

Installing

• Option 1: pip install

   pip install luanspaceship
  

• Option 2: Install manually

1. Clone the repo

   git clone https://github.com/Panchitoz1/luanspaceship.git
   

2. Ensure setuptools package is updated:

   python3 -m pip install --upgrade setuptools
   

3. Install using setup.py

   python3 setup.py install
   

   This should also install all package-dependences and program should run without problems.

4. (Optional to fix 'Module error') If for some reason when run the program in terminal Python returns a Module error due to some packages not being found, try this:

   • Ensure you are in the repo directory:

     cd /path/to/repo/LuanSpaceship
     

     Once there, simply run:

     pip install -r requirements.txt
     

     and try re-running command from Step 3.

(back to top)

Usage

First of all you can type in your terminal the following command:

luanspaceship

If everything runs fine it should print an ASCII spaceship with length 5 (which is default value if -length flag is not provided).

For general purposes to print an ASCII spaceship of length <integer-number> we can simply run:

luanspaceship -length <integer-number>

Another example could be if you want to print an ASCII spaceship with length 8 and also want to copy the ASCII art result into your clipboard:

luanspaceship -length 8 -clipboard

You can also change color combinations using -colorstyle flag and/or adding some attributes/styles when being displayed with -style flag. For example:

luanspaceship -colorstyle ocean -style blink

To check all flags and functions available I recommend check short help-page running:

luanspaceship -h

(back to top)

License

Distributed under the MIT License. Check LICENSE file for more information.

(back to top)

Contact

Francisco Carrasco Varela - email: ffcarrasco@uc.cl

Project Link: https://github.com/Panchitoz1/luanspaceship

(back to top)

Acknowledgments

• Science & Commit // Workshop 2022

(back to top)