Merge branch 'release/1.3.0'

.gitignore

@@ -1,8 +1,10 @@
 .idea/
 __pycache__/
-Logs/*
-!Logs/.logfolder.txt
+textscript/Logs/*
+!textscript/Logs/.logfolder.txt
 venv/
 build/*
 dist/*
+textscript/build/*
+textscript/dist/*
 app.spec

CHANGELOG.md

@@ -10,7 +10,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.2.0] - TBA
+## [1.3.0] - TBA
+# Changed
+- Added reload function which adds shortcuts without restarting the program
+- Added mechanism to update config file and repair broken sections
+- Added better exception handling for issues in config file
+- Added contributions file
+- Moved source files into textscript subdirectory and refactored code
+- Added notifications for added or removed textblocks
+- Reorganized classes so that methods make more sense
+- Renamed internal use methods according to PEP-8
+- Renamed Settings.py as ConfigUtils.py as this is more accurate
+
+## [1.2.0] - 2020-01-23
 ### Added
 - Support for three directories: default, local, and remote
 - Usage statistic printout during program start

CONTRIBUTING.md

@@ -0,0 +1 @@
+Hi All, I am a new developer who is still bringing this project up to collaboration standards. I will soon be opening this to public contributions once everything is in order. 

README.md

@@ -1,6 +1,114 @@
-# text-script
-An app that runs in the background and replaces text shortcuts with pre-saved blocks of text.
+# >text-script
+
+![Python Version](https://img.shields.io/badge/Python-3.8-blue)
+![License Information](https://img.shields.io/github/license/GeorgeCiesinski/text-script)
+
+![Dependencies](https://img.shields.io/requires/github/GeorgeCiesinski/text-script)
+![Open Issues](https://img.shields.io/github/issues/GeorgeCiesinski/text-script)
+
+An app that allows users to save shortcuts and textblocks. Typing a shortcut automatically replaces said shortcut with the content of the saved textblock. This app runs in the background and improves typing efficiency.
+
+## Motivation
+I came up with this idea when I discovered there was a lack of quality open source applications to fulfill this function. As a tech support agent, I find myself repeatedly copying the same blocks of text, such as signatures, instructions, and templates, and pasting them into emails. This is a common task in any tech support role, so I wanted to write an app to help my colleagues, and anybody else working in a similar role. 
+
+## Built With
+- Pynput
+- Pyperclip
+
+## Prerequisites
+- Python 3.8
+- Dependencies from requirements.txt
+
+## Installing
+
+At this time, the program is still in early development, so I recommend always downloading the latest version as it will usually contain fixes for large bugs or issues. 
+
+### Executable installation steps
+
+1. Go to the releases section of this repository.
+2. Download the top file in the latest release.
+3. Extract the text-script folder within this zip file. The whole folder is needed for the installation.
+4. Open the Config folder, and the config.ini file within this. Here, you can link the local or remote directories you will use to store your textblocks. 
+5. Create your shortcuts and textblocks in one of these directories. 
+6. Click text-script.exe to run the program. You may need to allow the program to run.
+
+### Source Code
+
+1. Download or clone the repository.
+2. Install the dependencies from requirements.txt (virtual environment is recommended).
+3. Ensure your CWD and sources root is textscript.
+4. Run the text-script.py file.
+5. Optionally, follow steps 4 & 5 from teh Executable Installation Steps to configure text-script.
+
+### Configuration
+
+The configuration for this app is stored in the textscript/config/ directory. As this program has to be manually configured until the GUI is complete, 
+please take care to only modify options in the DIRECTORIES section. The other sections are managed by the program. 
+
+The DIRECTORIES section contains options which refer to a default directory (textscript/textblocks/) which can be disabled by erasing the directory listed
+there, or replacing it with None. There are also options to set the local directory and the remote directory. The local directory is any folder 
+on your computer containing textblocks, and the remote directory is for any folder located on a network drive. Having all three is optional, and only one is
+necessary to store and load textblocks.
+
+## Screenshots and Gifs
+
+### The main console window
+At this stage in the project, text-script runs out of a console window. This outputs your stats, the loaded directories and shortcuts, and any shortcuts that
+were added or removed since the program was last ran.
+
+![Main Console Window](assets/screenshots/ConsoleWindow.PNG)
+
+### Usage Example
+As you can see, creating templates makes replying to customers quick and easy. text-script can be used in any text field.
+
+![Usage Example](assets/gifs/email.gif)
 
 ## Planned future updates
-- Save whatever the latest clipboard item is and replace it after shortcut is used. Currently the last textblock used fills the last clipboard spot
-- Create #reload command which reloads the shortcut list with all the latest updates.
+- GUI to configure app and add new textblocks.
+- Save whatever the latest clipboard item is and replace it after shortcut is used. Currently the last textblock used fills the last clipboard spot.
+- Optional usage tracking to advise the user which textblocks see the most use and which do not.
+
+## Features
+
+### Save Shortcuts & Textblocks
+text-script lets you create shortcuts which are used to quickly and easily recall textblocks later. Once you have configured the textblock directory, you can create unicode text files containing your textblocks. Within this directory, you simply need to name them #_______.txt where the blank is the shortcut you will type, and save the file using the unicode encoding. Future plans for text-script include creating a GUI which streamlines the shortcut/textblock creation process.
+
+### Supports Local and Remote Shortcuts
+text-script allows both local and remote shortcuts to be used. Remote shortcuts can be created by a manager or supervisor and can be shared with the whole team on the network drive. While using these remote shortcuts, you can also create your own local shortcuts that only you can see and use.
+
+### Built-in Commands
+text-script has several commands built in to streamline usage. These can be typed anywhere, ideally in a text field, although this is not necessary. 
+
+**\#help** - Typing this command followed by space, tab, or enter pastes the help text, which shows how to use the program. As it pastes text, some kind of textfield is required.
+
+**\#reload** - Typing this command after adding new textblocks loads them into text-script without having to restart the app.
+
+**\#exit** - Typing this command exits the program.
+
+### Saves your statistics
+As you use shortcuts, text-script saves the number of shortcuts you use, and the keystrokes you save. Each time the program starts, you are
+presented with an estimated amount of time you saved by using text-script.
+
+### Runs in the background
+This application runs in the background and does not need to be maximized or in focus. Simply starting the app and minimizing it is enough for it to recognize your shortcuts. 
+
+### Textblock directory can contain many subdirectory levels
+It is possible to make folders within the textblock directory to better organize your textblocks. Even these folders can contain more folders so that a complex organizational system is possible. 
+
+### Privacy
+text-script is being designed specifically with privacy in mind. As I intend for this application to be used free of charge by any individual or corporation, it is important to me that this application does not collect any private data. The contents of the textblocks are stored locally or within the user's network, and text-script does not duplicate or send this information anywhere. 
+
+Throughout the development of text-script, I will always keep privacy in mind and will continue to strengthen the capability of text-script to remain anonymous and private. If you have any concerns about this, please feel free to open an issue so that any potential risk can be swiftly resolved. 
+
+### Logs
+text-script contains anonymous logging capabilities which generate up to six log files. A new log file is created whenever text-script is started, or whenever the current log file becomes too large. These logs may help to resolve any bugs that you experience while using text-script. 
+
+Special care has been taken to keep the logs as anonymous as possible. The log files contain only program flow debugging messages, and only track characters that text-script believes are part of a shortcut. Specifically, whenever the delmiter (# key) is pressed, text-script logs the keys entered until space, tab, or enter is perssed, which indicates the shortcut is complete. Outside of the shortcut, no other keys are enterred into the logs, and neither are the contents of your textblocks. Despite limiting the effectiveness of the logs, this program is being written primarily with privacy in mind.
+
+The logs are manually created and have to be manually provided when bugs are encountered. You can find these logs in the Logs/ folder within the text-script directory. Simply zip the contents of this folder, or the specific log file in question, and create a new issue if one doesn't exist for the bug you encountered. 
+
+## Credits
+George Ciesinski (Lead Developer)
+
+## License
+Please see LICENSE.md