Minipy

Minipy is a CLI tool that combines small/big python tools and games in one big tool.

Table of contents

• Minipy
  • Table of contents
  • Installation
  • File structure
  • Configuration
  • Support
  • License
  • Status

Installation

To install minipy run this command in your terminal:

pip install minipy-tools

File structure

This is the file structure of the package:

└── 📁minipy
    └── 📁games
        ├── snake.py
    └── 📁tools
        ├── dice.py
        ├── link_shortner.py
        ├── send_email.py
    ├── __init__.py
    └── main.py

Configuration

For some tools/games you need some configuration. The configuration will redirect you to README for instructions. You can find those here:

Link shortner

You need to have a cuttly API key to be able to shorten links. To create one follow these steps:

1. Go to https://cutt.ly
2. Create an account / login
3. In your dashboard, go to API and then API key on the left menu

4. You can find your API key on the right side of that page
5. Copy it and Paste it in the configuration when asked

Send email

You need to have a Google App-password to be able to send an email. This is a second password to your Google account, we can use it in our app to send an mail with Gmail. To create one follow these steps:

1. Go to your Google account settings
2. In the menu on the left click Security
3. Click on 2-step verification and ensure it is turned ON, if not turn it on
4. Scroll down untill you see App passwords and click on it
5. Type a name for your new App password (this can be anything, like Email sender)
6. Click on make
7. Copy or write down the 16 chars password you see (This is important, because you can't see it again later!)
8. Enter it in the configuration when asked

Support

For support you can make an Issue on the Github repo, thanks for helping with my project.

License

MIT

Status

Ongoing: I'm still working on this project and constantly adding new tools and features...