Knowledgeable Kois

.flake8

@@ -1,5 +1,6 @@
+[flake8]
 max-line-length=100
-application_import_names=projectt
+application_import_names=project
 ignore=P102,B311,W503,E226,S311,W504,F821
 exclude=__pycache__, venv, .venv, tests
 import-order-style=pycharm

.gitignore

@@ -1,3 +1,7 @@
+# Project-specific files
+project/*.ini
+project/**/autosave.data
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -102,3 +106,10 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# IDEA workspace
+.idea/
+
+# compiled sphinx HTML documentation
+docs/build
+.vscode/settings.json

Pipfile

@@ -5,11 +5,21 @@ verify_ssl = true
 
 [dev-packages]
 flake8 = "*"
+pytest = "*"
+sphinx = "*"
 
 [packages]
+pyqt5 = "*"
+flake8 = "*"
+lxml = "*"
+requests = "*"
+thesaurus = "*"
 
 [requires]
 python_version = "3.7"
 
 [scripts]
-lint = "python -m flake8"
+lint = "python -m flake8"
+start = "python -m project"
+test = "pytest project/tests/"
+gendoc = "pydoc -g"

README.md

@@ -29,17 +29,82 @@ You should be using [Pipenv](https://pipenv.readthedocs.io/en/latest/). Take a l
 * Running the application (assuming you use our project layout): `pipenv run start`
 
 # Project Information
+##### Team Name
 
-`# TODO`
+Knowledgeable Kois
 
+##### Members
+
+[BWACPro](https://github.com/BWACpro)
+
+[kaleidawave](https://github.com/kaleidawave)
+
+[Transfusion](https://github.com/Transfusion) 👑
 ## Description
 
-`# TODO`
+### Theme
+Clipboard Mangler
+
+### What does it do?
+It's a clipboard manager in all its usefulness:
+
+   - For when you `Ctrl-Z` but have no way to redo
+   - For when you need to quickly swap items in and out of the clipboard
+   - For when you need images and text to be quickly accessible at the same time
+   - ...etc
+
+However, it has a mind of its own...
+
+### Feature Breakdown
+#### Core
+* ~~Hooks into Ctrl-C, Ctrl-X and Ctrl-V~~ **done!**
+* Able to select specific copied items and modify them 
+  * Able to edit copied text
+  * ~~Able to add and remove copied items~~ **done!**
+  * ~~Able to rearrange copied items~~ **done!**
+  * ~~Able to delete specific items~~ **done!**
+* ~~Clipboard should be saved after exiting the app~~ **done!**
+* _(Keep entire clipboard history as a stack too?)_
+* _(Tray Logo, from which we can access settings?)_
+#### Crappifying
+* Plugin-based architecture, each crappifier should be a class which applies its own transformation onto an image or text
+* Ideas for text
+  * ~~Misspell words~~ **done!**
+  * Randomly transpose words around
+  * ~~Replace entire blocks of text with "funny" copypasta from APIs~~ **done!**
+* Ideas for images
+  * Deep fry and load back into memory
+  * ~~Randomly rotate~~ **done!**
+  * Randomly add meme images to the front of the clipboard
+* ~~Randomly select transformations to apply.~~ **done!**
 
 ## Setup & Installation
 
-`# TODO`
+Clone this repo, in a terminal run `pipenv install` then `pipenv run start`
+
+Unit tests are written using the [pytest](https://docs.pytest.org/en/latest/) framework. 
+
+`pipenv run test` runs the available tests.
 
 ## How do I use this thing?
 
-`# TODO`
+As you copy and paste text or images, the copied content will be added to the scroll area of the main window.
+
+The numbers on the left, indicated by ③ in the infographic below indicate their position in the list of copied items.
+
+A selected item, ① in the infographic below, has a different background color compared to other items. After selection, it may be moved up or down the list, i.e. swapped with the item above or below it, as shown by ②. Remove removes the selected item.
+
+This may be useful if you want to organize your frequently accessed items at the top. Unchecking the `Always load top item into clipboard` option in the Settings menu will automatically copy the selected item into the system's clipboard.
+
+Saving the state of the clipboard is done automatically if the option in Settings is checked, or may be done manually in the File menu.
+
+![Screenshot of Clipboard Mangler on macOS Mojave](https://i.imgur.com/FbxCbjF.png)
+
+## Documentation
+
+Documentation is generated using [Sphinx](http://www.sphinx-doc.org/en/master/). To build:
+```sh
+cd docs
+sphinx-apidoc -f -o source/ ../project/
+make html
+```

azure-pipelines.yml

@@ -35,4 +35,7 @@ jobs:
     displayName: 'Install project dependencies'
 
   - script: pipenv run lint
-    displayName: 'Lint the project'
+    displayName: 'Lint the project'
+
+  - script: pipenv run test
+    displayName: 'Unit test the project'

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/source/ClipboardManager.rst

@@ -0,0 +1,38 @@
+ClipboardManager package
+========================
+
+Submodules
+----------
+
+ClipboardManager.ClipboardManager module
+----------------------------------------
+
+.. automodule:: ClipboardManager.ClipboardManager
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ClipboardManager.ClipboardObject module
+---------------------------------------
+
+.. automodule:: ClipboardManager.ClipboardObject
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ClipboardManager.HistoryManager module
+--------------------------------------
+
+.. automodule:: ClipboardManager.HistoryManager
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: ClipboardManager
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/PluginManager.rst

@@ -0,0 +1,22 @@
+PluginManager package
+=====================
+
+Submodules
+----------
+
+PluginManager.PluginManager module
+----------------------------------
+
+.. automodule:: PluginManager.PluginManager
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: PluginManager
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/Stack.rst

@@ -0,0 +1,22 @@
+Stack package
+=============
+
+Submodules
+----------
+
+Stack.Stack module
+------------------
+
+.. automodule:: Stack.Stack
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: Stack
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/Widgets.rst

@@ -0,0 +1,22 @@
+Widgets package
+===============
+
+Submodules
+----------
+
+Widgets.MainListWidget module
+-----------------------------
+
+.. automodule:: Widgets.MainListWidget
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: Widgets
+    :members:
+    :undoc-members:
+    :show-inheritance: