Merge branch 'release/1.3.1'

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,36 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant. You can check the options by putting x in between the brackets.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+- [ ] Test A:
+- [ ] Test B:
+
+**Test Configuration**:
+* OS:
+* IDE:
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules

.gitignore

@@ -3,8 +3,6 @@ __pycache__/
 textscript/Logs/*
 !textscript/Logs/.logfolder.txt
 venv/
-build/*
-dist/*
 textscript/build/*
 textscript/dist/*
-app.spec
+textscript/text-script.spec

.travis.yml

@@ -0,0 +1,10 @@
+
+language: python
+
+python:
+ - "3.8"
+
+
+install: pip install -r requirements_dev.txt
+
+script: pytest

CHANGELOG.md

@@ -7,10 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Planned Updates]
 - Check for duplicate shortcuts & handle
 - Ability to correct shortcut typos using arrow keys instead of just backspace
-
-## [Unreleased]
-
-## [1.3.0] - TBA
+- GUI support
+- OSX & Linux Support
+
+## [1.3.1] - 2020-03-12
+#Added
+- Implemented Continuous Integration 
+- Added command delimiter (!)
+- Added functions to predict the codec and decode textblocks with greater accuracy. This should
+resolve bugs encountered when using non unicode textblocks.
+- Added better compatibility check for textblock naming convention.
+#Changed
+- Updated logging to better capture errors which occur during textblock decoding
+- Moved commands from shortcut delimiter (#) to command delimiter (!)
+
+## [1.3.0] - 2020-02-21
 # Changed
 - Added reload function which adds shortcuts without restarting the program
 - Added mechanism to update config file and repair broken sections

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -1 +1,28 @@
-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. 
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Code Style and Coding Practices
+
+- Please ensure you follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) whenever possible.
+- Ensure you include a docstring comment in each function so the purpose and behaviour can be easily understood. See the other functions for an example of this if needed.
+- Ensure that you name variables and functions only used locally as _name (single underscore) as per PEP 8. 
+- Ensure that you use professional language in the code & comments. For example, including swear words in the project is unprofessional. 
+
+## Logging
+
+- If you make new functions under existing classes, please ensure you use self._log.debug/info/exception("message") to write helpful logs throughout your function.
+- For the first log your function would output, start off the message with "scriptname.py: message" where the script name is whichever file the function is created in. Following logs from the same function do not need to include this.
+- If you need to create a new class, pass the L instance from text-script.py if possible. 
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies (such as the build and dist folders generated by Pyinstaller) are not included in the          branch.
+2. Update the README.md with any required details such as new features, important new information, or screenshots if needed.
+3. Increase the text_script_version number in text-script.py and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may create a merge request and wait for one of the developers to review the changes and sign off on them. 
+5. Once this is done, we will merge it into develop.