Repository navigation
Quick Start Guide
Welcome to Antimatter, the lightweight and blazing fast IDE made for python development. You are here reading this likely because:
- You are tired of bloated alternatives such as PyCharm & VS Code that eat a lot of resources for absolutely no reason.
- You want to try a new way for typing python scripts.
- You want to be unique.
Well, turns out you don't need to be a genius to understand how it works. I've taken the time to make Antimatter as user-friendly as possible, as well as documenting every single function and explaining their jobs.
Warning
Since the software is still in the BETA stage, it is better to use it for non-important projects as the IDE could have missing features depending on your workflow or just be unstable and/or have bugs that we didn't notice/fix yet. Also expect a slight learning curve for streamlined workflow.
To get started, you need to install Antimatter. This changes radically depending on your operating system (Windows / Linux).
Note
We don't support macOS, so there is no information about how to install/build from source the IDE on that OS.
You can still try figuring it out. But we won't provide any form of support and any bug report from that OS will not be taken into consideration.
Warning
We stopped supporting Windows for the moment. New releases might not feature an installer anymore until someone maintains the installer again.
On Linux, you can build the software from source. This can take a bit of time, but you can also use the new Flatpak version of the application (which is limited) or use the executable bundled with the latest release.
Anyways, here are the steps you need to take in order to build Antimatter from source on your Linux desktop:
- Install Git or Download the source code from Github:
- To install Git, run the following command:
- For Redhat-based distros (like Fedora):
sudo dnf install git - For Ubuntu-based distros (Like Linux Mint or Zorin):
sudo apt install git
- For Redhat-based distros (like Fedora):
- To download the source code from GitHub, go to the main page of the repository, then click "Code" and select "Download Zip".
- To install Git, run the following command:
- After installing Git, clone the repository using the following command:
git clone https://github.com/ComicalSoftwares/Antimatter.gitIf you downloaded the source code manually from GitHub, simply unzip the
.zipfile that you got. - Once you got the files, move them wherever you want or keep them where they are. It doesn't matter just open the source code's folder and open a new terminal inside that directory.
- Inside that terminal, install the required dependencies by running the following command:
pip install PyQt6 pyflakes Pillow pypresence python-lsp-serverThere might be missing dependencies so make sure to try and launch "main.py" to make sure you have everything.
5. If you you want to have Antimatter as a clickable icon inside your applications menu, make a new script inside ~/.local/share/applications/ and name it Antimatter.desktop. Then paste the following: (This step is Optional)
[Desktop Entry]
Type=Application
Name=Antimatter
Exec=python3 /home/YOU/Antimatter/main.py # Replace this line by the path to main.py
Icon=/home/YOU/Antimatter/AppIcon.png # Replace this line by the path to AppIcon.png
Terminal=false
StartupWMClass=io.github.comicalsoftwares.antimatter
Category=Development;IDEYou can also simply use the one inside the cloned folder, just make sure to move it to this directory ~/.local/share/applications/
On this Operating System, an installer can be downloaded and executed from the releases page. No complex installation steps are needed to be followed, Nice!
If you still need to know how to do it then:
- Head over to the releases page.
- Find and open the latest release available.
- Scroll down to the download section and click on
installer.exeor something similar to it. - Wait for the download to finish, then open the downloaded file.
- A pop-up will show up asking for your permission to run the application with administrator privileges.
- Follow the on-screen instructions and wait for the installation to finish. It shouldn't be too hard.
Now that we're done installing the software, it is time to actually learn how does it work. From what you can see, we have a code editor, tabs so you can quickly switch from file to file, and a file manager. Also let's not forget the top bar
On the top bar, we have 4 dropdown buttons, if you click one of them, a group of other buttons will appear in a spare menu.
- New file: Discards all unsaved changes and creates a brand new, unnamed file.
- Open file: Discards all unsaved changes and opens an existing file on the system.
- Open Folder: Opens a specific folder only on the file manager.
- Save: Saves the current file.
- Save As: Saves the current file with a brand new name.
- Close current Tab: Closes current tab.
- File Manager: This is a toggle button, it will either enable or disable the file manager sidebar.
- Toggle Code/Terminal view: Switches back and forth between the terminal and code view.
- Run: Toggles terminal view and executes a python file for debugging purposes.
- Build project: Asks you to open a build template to start compiling your project in the background. See how to make a build template
- Find issues: Will scan the current script and give you a summary of all issues it got.
Important
Make sure that pyflakes is installed or else the "Issues finder" feature won't work.
- Configure Project: Creates and activates a .venv environment
- Check for updates: Only checks for updates, the update must still be done manually... the old school way.
- Refresh Discord RPC: Refreshes the Discord rich presence connection.
- Set custom RPC status: Sets the text you provided in the prompt as your current RPC details
- About Antimatter: Shows information about the softwares. Mainly the version, license and credits.
After learning what each feature of Antimatter does, it is time to get you into the workflow. Let's make a simple "Hello World" script to apply our knowledge.
To get started into Python development. We obviously need to create a file so we can work on.
You can skip this step and start typing right away, or if you're a psychopath.. then go to File > New file
Lets make something simple. I've made 2 starter templates, they're both simple and easy to understand. One says "Hello World" inside the terminal, the other one says it inside a Tkinter window.
Type manually or copy-paste one of them:
Template A:
print("Hello World")Template B:
# Let's import Tkinter
import tkinter as tk
# Let's configure the main window
root = tk.Tk()
root.title("Hello world template in Tkinter")
# Let's make the label that will contain our "Hello World" text
hi = tk.Label(root, text="Hello World")
hi.pack()
# This loop ensures that the window won't disappear the second we launch it
root.mainloop()After that, save your file by going to File > Save As and give it a name.
Now its time to test our script !
Go to Task > Run or press F5 on your keyboard, then select your script and Ta-Da ! We successfully made a Python script inside of Antimatter for the 1st time. Huge achievement isn't it ?
Did I mention a keyboard shortcut like F5 earlier ? Well, time to teach you some time-saving keyboard shortcuts you need to know. This will save you a lot of time (And apparently, this makes you a pro programmer.. Shhhhh no one needs to hear that....)
- New File:
Ctrl + N - Open File:
Ctrl + O - Save File:
Ctrl + S - Save File As:
Ctrl + Shift + S - Run:
F5 - Compile script:
Ctrl + F5 - Toggle terminal/code view:
Ctrl + T - Switch tabs:
Ctrl + Tab - Toggle file manager sidebar:
Ctrl + B - Find Issues:
Ctrl + I - Find:
Ctrl + F - Find and Replace:
Ctrl + R
I did mention before that Antimatter can build your projects for you. All you need to do is to create a build template, which saves you time from manually typing the command inside your terminal.
- Create a text file (It must be a simple
.txtfile made inside your default notepad). - Write inside that text file your usual pyinstaller command (or whatever compiler your use).
- Save it and you're done. Next time you want to build, press
Ctrl + F5and select your build template.
Looks like a joke, but its incredibly useful and powerful.. While it is compiling, the IDE will freeze. We are aware of this and it is an intentional security feature designed to prevent you from editing the script while its building the executable.
Once done, Antimatter should tell you if the compile went successful or not. In case it failed, it will tell what went wrong so you can analyze and find the problem.
These are a few more tips I can give to help you get the most out of Antimatter to improve your workflow:
Tip
Keep checking for updates. I can't stand not telling people to do that, there is no need to keep coming to the repo to manually check for updates, you can check right inside of Antimatter by going to Tools > Check for updates.
That feature only checks if there is an update, it doesn't install it for you. You still have to manually rebuild the project in case there is a pending update. Or.. use the Flatpak version and have it automatically update !
Note
As said earlier, this software is in development, nothing is perfect yet. You can come across an issue, but it is most likely going to be fixed in a future release.
This is all for now, we hope you enjoy Antimatter !
Visit https://antimatter.codelyteam.com/#docs/Quick-Start-Guide for a better reading experience of this wiki.