Quiet-Text: A Python repository from Sounakde

Quiet Text

Quiet Text is a simple, minimalist text editor made with Python's Tkinter GUI library. Quiet Text aims to create a calming and distraction free text environment for writing code and taking notes.

Preview Images

About

Quiet Text aims to give you a clean and simple text editor experience. Everything is right in front of you and all completely customizable to your preferences. Too many text editors clutter their ui with unnecessary tooling that overwhelms their users. It isn't uncommon for somebody to lose hours of their precious work day mulling over and disabling irritating configuration settings in their text editor/ide. We want to eliminate the annoyances of a noisy/busy text editing environment and bring you an environment that has the main goal of increasing focus and eliminating distractions.

Installation/Setup
Keyboard Shortcuts and Usage
Contributing
Contributors

Installation

This project requires Pygments as well as PyYAML. Both of these packages can be installed through a virtual environment with requirements.txt. After you install the dependencies, you can simply head into the src directory and launch the editor from quiet_app_launch.py.

Mac and Linux installation:

python3 -m venv env

source env/bin/activate

pip3 install -r requirements.txt

cd src

python3 quiet_app_launch.py

Windows:

python -m venv env

env\Scripts\activate.bat

pip install -r requirements.txt

cd src

python3 quiet_app_launch.py

This project also requires a Python3 interpreter with Tkinter support. You can test it using

python3 -m tkinter

In case your (GNU/Linux) machine does not support tkinter, there's a way to run it inside Docker (whereas you can also use another base image than ubuntu):

FROM ubuntu
RUN apt update && apt install -y python3-tk x11-apps
RUN mkdir /code
WORKDIR /code
ADD . /code
CMD ["/usr/bin/python3", "-m", "quiet"]

Now, expose an environment variable to allow access to your host system XAUTH="$HOME/.Xauthority" and build the image using docker build -t quiet .. You can start a container using

docker run --network=host --rm -e DISPLAY=$DISPLAY -v $XAUTH:/root/.Xauthority quiet

Be aware, that the Docker container has full access to your machine! So you better trust the executed code.

Keyboard Shortcuts and Usage

Quiet Text has shortcuts for most commonly performed actions. The list of all the shortcuts is presented bellow:

Command	KeyBinding	Description
Copy	`ctrl`+`c`	Copy selected text
Cut	`ctrl`+`x`	Cut selected text
Paste	`ctrl`+`v`	Paste text from the clipboard
Bold	`ctrl`+`b`	Bold selected text
Find and Replace	`ctrl`+`f`	Find and replace specified text
Highlight	`ctrl`+`h`	Highlight selected text
Hide Menu	`alt`	Hides menu bar from view in the text editor
Hide Line Numbers	`ctrl`+`shift`+`l`	Hides line numbers from text area
New File	`ctrl`+`n`	Open a new empty file
Open File	`ctrl`+`o`	Open an existing file
Color Menu	`ctrl`+`m`	Opens color menu
Run File	`ctrl`+`r`	Run the currently active file
Save	`ctrl`+`s`	Save the currently active file
Save As	`ctrl`+`shift`+`s`	Save the currently active file under a different name
Change Font Size	`ctrl`+`mousewheel`	Increases or decrease font size

IMPORTANT: If you don't want your teminal to close when using the ctrl+r run command, add an input field at the end of your script.

for example...

for i in range(10):
	print('hello world')


input()

Contributing

Issues are open to anyone and everyone, but you must comment on the issue first and communicate to me that you are working on it. If you are confident in your ability, I will assign you to the issue.
Don't work on an issue that isn't assigned to you unless you communicate with the assignee first.
If you make an improvement on an existing feature, make sure to create an issue first and list the fixes or features you have made to the code.
All PRs must be made from a Branch. Create a separate branch for every Issue you are working upon and once found fit, make a PR.
Please make sure your code works before you submit it :)

check CONTRIBUTING.md for guidlines on how to make a pull request.

Goals

Create a visually pleasing text editor! ;)
Add syntax highlighting for Python.
Allow user's to launch the terminal and run their scripts from any platform.
Add special markdown for making lists and notetaking.
Allow full customization of the editor's theme and colors.
Add helpful features for programming like autoclosing brackets and parenthesis.

suggestions are welcome!

Contributors

Thanks goes to these wonderful people!:

_{Seth Walker} 💻 📖 🐛 🖋 🎨	_{Siddharth Singha Roy} 🐛	_{Thainá Pires} 📖	_{Thanarathanam Lakshmanan} 💻	_{Punid Ramesh} 💻	_{André Jaenisch} 💻 📖	_aish0007 📖
_{HRISHIKESH SARMA} 💻	_{Kirill Vackevich} 💻