Skip to content

Commit 5a8425b

Browse files
committed
Release v1.4.0
1 parent dd70861 commit 5a8425b

File tree

5 files changed

+522
-184
lines changed

5 files changed

+522
-184
lines changed

README.md

+25-7
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,36 @@
11
# SparklyPython
2-
The most powerful, beginner-friendly, and open-source Python IDE, fully written in Python and using Tkinter for GUI.
2+
SparklyPython is a powerful and open-source Python IDE based on Tkinter. It provides many features, fully customizable, and beginner-friendly!
33

4-
You can convert the main file `main.py` to an `.exe` file using [PyInstaller](https://pypi.org/project/pyinstaller/). The command was used is here:
4+
- Highlighter for Python syntax
5+
- Powerful Python Autocomplete
6+
- Files Explorer to navigate files easily
7+
- Beginner-friendly and easy to use
58

6-
```
9+
## 📥 Download
10+
11+
To download the application, simply go to [releases](https://github.com/TFAGaming/SparklyPython/releases/latest) and scroll down until you find the assets, click on the **.zip** file to download it. When the download finishes, unzip the compressed folder to a normal folder and start the application by running the file **SparklyPython.exe**.
12+
13+
Ensure SparklyPython has permission to write and read files because if these permissions are missing, the application will return many errors and eventually crash.
14+
15+
## 💿 Convert `.py` to `.exe`
16+
17+
To convert the main source code of SparklyPython to an executable file, you must install [PyInstaller](https://pyinstaller.org/en/stable/) and then use the following command for the conversion:
18+
19+
```sh
720
pyinstaller main.py -w --icon=icon.ico
821
```
922

10-
Enjoy while using SparklyPython! =)
23+
PyInstaller will eventually make two directories, "build" and "dist". The important folder is the "dist" because it contains every **.dll** file and modules that makes the app run on any operating system, so you can delete the "build" folder, drag **icon.ico** to the **build/main** folder, and convert the **build/main** to a compressed file (**.zip**).
24+
25+
## 🐛 Known bugs
26+
- If the configuration file has a missing property while the settings window is loading the file, it will eventually stop the window from getting ready.
27+
- When modifying a keyword plugin that has a dot behind the current word by selecting an option from the SparklyPython Autocomplete list, it will remove anything behind the current word and replace it with the selected keyword. For an example, the full string `test_class.test_funct...` will be replaced by `test_function` only, not `test_class.test_function`.
28+
- When Files Explorer loads many files and directories, the app might freeze and eventually crash. If the application is being used while Explorer is loading, it might use a lot of RAM, which eventually slows down the device.
1129

12-
## Screenshots
30+
## 🖼️ Screenshots
1331
<img src="./screenshots/screenshot-1.png">
1432
<img src="./screenshots/screenshot-2.png">
1533
<img src="./screenshots/screenshot-3.png">
1634

17-
## License
18-
The MIT License ([View here](./LICENSE))
35+
## 📄 License
36+
The **MIT** License ([view here](./LICENSE))

0 commit comments

Comments
 (0)