Forem: Nicolas Agudelo

Folder Organizer Using Python and Tkinter

Nicolas Agudelo — Fri, 01 Jul 2022 01:16:23 +0000

Hello everyone!

Folder Organizer

Here is my approach to an application to organize the files you have on any folder on your computer sorting them according to their extension.

This was also the first time I experimented creating a (super simple) user interface on python instead of having the user doing everything on the terminal. I used the module Tkinter to create this window for the user to interact with.

Creating the User Interface
Pressing the Start Button
The organize() function
Installing the Application
Closing notes

Creating the User Interface

The first step was creating the main window. Using the Tkinter module, we can create an object of the class tkinter.Tk.
In my case, I called it root as most of the examples I found on using this module.

# Creating the main window for the user interface.
root = Tk()

After that, I started personalizing my root object or main window. Changing the default icon for a free personalized icon, I found at freeicons.io (thanks to Ginkaewicons who created the icon.), setting the window geometry and adding a title to it.

# Replace the default icon
try:
    root.iconbitmap('organizer.ico')
except:
    pass

# Setting up the geometry of the window.
root.geometry('320x195')

# By setting both parameters to false the user can not resize the window.
root.resizable(False, False)

# We make sure the program gets the main focus on the user's Desktop.
root.focus()

# Title of the main window
root.title('Organizer.py')

Next, I decided on the widgets I wanted the main window to have.

In my case, I decided to add:

A Label that will give information to the user about what the program does, what it is expecting, or when it has finished.
A Start Button which will start the primary function of the program.
A Progress Bar that gives the user a visual reference that tells him that the program is doing something and when it has finished.

# Creating our start button, which will start the program.

startbutton = tk.Button(
    root,                   # Setting the 'master' window for this widget
    text = 'Start',         # Setting the text to display on this widget
    command = find_dir,     # This will be the function that executes when you press the button.
    cursor='hand2',         # This will change the cursor when the user hovers it over the button.
    )

# A description label to give information to the user about the program status.

description_label = tk.Label(
    root,                   # Setting the 'master' window for this widget
                            # Setting the text to display on this widget
    text = 'You can use this program to organize all your different \ntype of files in folders\n\nJust choose the folder that you want to organize\nby clicking the Start button below',
    justify= 'left'         # With this, every new line will start at the left of the label.
    )

# A progress bar for the user to follow the program's progress.

progressbar = ttk.Progressbar(
    root,                   # Setting the 'master' window for this widget
    orient=HORIZONTAL,      # Setting the progress bar horizontally
    length = 240,           # Setting the lenght of the progress bar in pixels
    mode = 'determinate'    # We know when our program finishes so we use the determinate mode
    )

You can find information about all of the attributes of these and more widgets here.

Finally, I placed the objects in the main window:

#Placing the objects we created for our user interface.

description_label.place(x=4, y= 5)
startbutton.place(x=140, y= 140)
progressbar.pack(side='bottom', pady=5)

Since the user can not resize the window, I placed the label and button at specific positions using the x and y axes. For the progress bar, I put it at the bottom of the window, adding a 5px padding on top and bottom to avoid having it entirely on the window's border.

After doing this we get our main window:

Main Window

Pressing the Start Button

Now that the main window is done the start button will be the one responsible of doing what the main goal of the program is. Once it is pressed it will call the find_dir() function which will prompt the user about which folder he wants to organize using the filedialog method from the Tkinter module.

# The find dir function will ask the user for the folder he wants to organize. 
# In case he presses 'Cancel', the `dirname` variable will be empty
# In this case, we ask the user to please select a folder to be able to organize it
def find_dir():
    global description_label
    frm = ttk.Frame(root, padding=10)
    ttk.Label(frm, text="Select the folder that you want to organize")
    dirname = filedialog.askdirectory(parent=root, initialdir='~', title='Select the folder that you want to organize')
    # If the user closes the file dialog or presses cancel the dirname will be empty in this case, we change the text on the label of the main window and do nothing else.
    if dirname == '':
        description_label['text'] = 'Please select a folder to continue\n\nJust choose the folder that you want to organize\nby clicking the Start button below'
    else:
    # Once we have the directory that the user wants to organize we pass it to the function organize()
        organize(dirname)

Selecting the Folder

If the user closes the window asking for the folder or presses 'Cancel' the program will return to the main window and inform him that a folder is needed for the program to work allowing him to press the start button to start the process again.

Message displayed when no folder was selected

After that, if the user selected a folder, two things could happen:

There are no files on the selected folder, in which case the program will inform the user about it and give him the option to press the start button again if he wants to.

Message displayed when a folder with no files was selected

There are files on the selected folder in which case the program will call the organize() function which will then organize all the files into folders.

Folder Organized Message

The organize() function

The organize() function is in charge of putting every file in the correct folder. To achieve this, I created different categories of files, and using match case, I assigned every file to a folder. In case there is an extension that doesn't fall into any of the categories I created, the program will put it into a folder called Others

I won't put the portion of the code that does this here because it's a little bit too long, but you can check the code here to see the categories I created and what extension falls into each category.

Thanks to file-extensions.org, the place from where I got lists of the most common file extensions and got the idea of how to name each category.

Installing the Application

You can find the code for the application at this repository at GitHub.

You can also download the executable on this link

Closing notes

Feel free to contact me through my email (public on my profile) if you find any issue or problem with the application or if you have any advice about how something might be better implemented. You can also try adding more stuff to the application; I would love to see that.

Thanks.

Hero's Journey a text-based RPG Game.

Nicolas Agudelo — Tue, 28 Jun 2022 23:58:45 +0000

Hero's Journey V1.0

Hello everybody!

This is the first working version of the python text-based RPG game that I have called Hero's Journey.

In this game, you will find yourself in the shoes of the hero who must defeat the Demon King to bring peace back to his world.

To do this, you must train and level up to improve your stats, you will do this by fighting against different enemies (minions of the Demon King), gaining experience, potions, and money once you defeat them, money, that you will be able to then use on the store to buy more potions to help you on your adventure.

Be careful with how much you risk while training or when fighting the bosses since if you are left with no more health points, you will lose all your potions and part of your money.

The game is divided into six sections.

Hero's Journey V1.0
- Game Start
- The Village
- Training Grounds
- Store
- Check Stats
- Battle Boss
- Installing the game
- Closing notes

Game Start

At the beginning of the game, the game will ask you for your name, and you will receive ten stat points to distribute as you wish on four different attributes:

Attack: Determines how much damage the player deals
Defense: Determines how much damage the player ignores.
Speed: Determines the chance of the player avoiding an enemy attack.
Crit Chance: Determines the chance of the player hitting a critical strike when attacking.

Once you have done this, the game will take you to The Village

The Village

This is basically the game's menu, where you can choose what to do next.

You will recover your HP every time you come back to the Village and also be transported back here when an enemy defeats you.

Game's Menu

Training Grounds

Here is where you will face the minions of the Demon King, accumulating experience, potions, and money.

You will face each of them in turn-based combat, where the player will choose between using a potion to recover some health or attacking the enemy in front.

Once you decide to attack, it will be the enemy's turn to attack you.

Using potions in combat will not make the player lose his turn.

Battle Example

Once you defeat the enemy, you will be given the option to continue training which will set up another combat, or go back to the village to recover your HP.

Store

Here you will be able to spend the money you have won by killing enemies on potions.

Potions are handy if you want to stay training for a while or if you are going to face one of the game's bosses.

Each potion will recover 20% of your maximum health, and you can carry a maximum amount of 10 potions at a time.

Store

Check Stats

As you level up through the game you will accumulate stat points to improve your attributes. Here is where you can spend all those stat points on the 4 different attributes mentioned at the Game Start section as well as checking what your current stats are:

Player Stats

The player can choose how he wants to spend his stat points; however, every attribute will reach its maximum level once it reaches level 10.

Spending Stat Points

Stat Points Used

Battle Boss

The game has four bosses.

The three generals of the army:

Abadon
Mammon
Belphegor

And the Demon King himself: Lucifer

The combat mechanics against the bosses are the same as with the minions; however, bosses are much more robust. If the player has not trained enough, it might be virtually impossible to defeat them until the player reaches a certain level.

Fighting Without Training

Installing the game

You can find the code for the game at this repository at github.

You can also download the executable on this link

Closing notes

Feel free to contact me through my email (public on my profile) if you find any issue or problem with the game or if you have any advice about how something might be better implemented. You can also try adding more stuff to the game I would love to see that.

Thanks.