OrderMyRepos

Tools to help you with the chaos that comes after cloning too much repositories
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
• addRepo.py
• showRepo.py
4. License
5. Contact

About The Project

Tools written in Python3 to help you organize your repositories Github cloned repositories

(back to top)

Getting Started

How many times has happened to you that you clone and clone repositories but with time you forget what they suppose to do? So you have to revisit the site, check what it does, forget again with the time what it does and so on...

For this reason I decided to create a couple of simple features to put order in your (and mine) chaos for the repositories we use.

Prerequisites

• Python 3.8 or higher
• pip3

Installation

1. Clone the repo

   git clone https://github.com/GunZF0x/OrderMyRepos.git

2. Install Python3 libraries via pip

   pip3 install beautifulsoup4
   pip3 install tabulate
   pip3 install pyperclip

   or run

   pip3 install -r requirements.txt
   

...and you are ready to go!

(back to top)

Usage

'add' Command

Just get the url of the Github repository and add it to out "library":

python3 ordermyrepos.py add -w https://github.com/USER_HERE/REPO_HERE

Using this repository as an example:

python3 ordermyrepos.py add -w https://github.com/GunZF0x/OrderMyRepos

by default, this will create a file repositories.txt in the current directory the script is being run (not where the script is located) with multiple columns:

1. Save the original Github's weblink.
2. Extract the title/main header of the Github's repository.
3. Select for which Operating System (OS) is the repository scoped for (default: Any).
4. Selects the (main) programming language, as indicated by Github's language bar.
5. Extracts the description for the repository

Every time you run this script you will add a new line to your file; if the repository is already added it will throw an error.

However, I know this is a lot of stuff to our eyes if we open the file repositories.txt (or whatever the file you have saved your repos). For that reason I also created an additional featured called showRepo.py

'show' Command

python3 ordermyrepos.py show 

this will display the repositories that lies in your repositories.txt file in the current directory.

However, if you want to use a file that is located anywhere in your system just do:

python3 ordermyrepos.py show -f /path/to/repo/file.txt

For example, you can search for the word organize for any repository written in Python after ordering alphabetically by their author:

python3 ordermyrepos.py show -f examples/repositories.txt -s organize -l python --sort-by-author

Use

python3 ordermyrepos.py

or

python3 ordermyrepos.py -h

for more info.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

GunZF0x - [email protected]

Project Link: https://github.com/GunZF0x/OrderMyRepos

(back to top)