Merge pull request #9 from skippy-dev/develop

v1.2.4

.gitignore

@@ -27,6 +27,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+nsis/output/
 
 # Installer logs
 pip-log.txt

LICENSE

@@ -132,7 +132,7 @@ implementation is available to the public in source code form.  A
 produce the work, or an object code interpreter used to run it.
 
   The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
+the source code needed to preview, install, and (for an executable
 work) run the object code and to modify the work, including scripts to
 control those activities.  However, it does not include the work's
 System Libraries, or general-purpose tools or generally available free

README.md

@@ -1,5 +1,5 @@
 <h1 align="center">
-  <img src="https://raw.githubusercontent.com/skippy-dev/skippy/main/img/skippy.png" width="200px" alt="skippy">
+  <img src="https://raw.githubusercontent.com/skippy-dev/skippy/main/img/banner.png" alt="skippy">
 </h1>
 
 <p align="center">
@@ -8,10 +8,15 @@
   <a href="https://pypi.python.org/pypi/skippy-pad/"><img src="https://img.shields.io/pypi/v/skippy-pad.svg"></a>
   <a href="https://pypi.python.org/pypi/skippy-pad/"><img src="https://img.shields.io/pypi/pyversions/skippy-pad.svg"></a>
   <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+  <a href="https://GitHub.com/skippy-dev/skippy/"><img src="https://img.shields.io/github/downloads/skippy-dev/skippy/total.svg"></a>
 </p>
 
 <p align="center">
-<a href="https://GitHub.com/MrNereof/"><img src="http://ForTheBadge.com/images/badges/built-with-love.svg"></a>
+  <a href="https://discord.gg/jQgWsT2umu"><img src="https://img.shields.io/discord/836620906755129386.svg?label=Discord&logo=Discord&colorB=008aff&style=for-the-badge"></a>
+</p>
+
+<p align="center">
+  <a href="https://GitHub.com/MrNereof/"><img src="http://ForTheBadge.com/images/badges/built-with-love.svg"></a>
 </p>
 
 <h3 align="center">
@@ -22,7 +27,7 @@ Skippy - Simple. Comfortable. Powerful. notepad for www.scpwiki.com
 Installation
 </h2>
 
-If you have Python you can install Skippy using pip:
+If you have Python 3.7 or later you can install Skippy using pip:
 
 ```
 $ python -m pip install skippy-pad
@@ -52,7 +57,7 @@ Features
 * Support all wikidot sites
 * Autoupdating system
 * Multi language interface
-* Advanced autocomplete, suggestion and syntax checking engine to the Wikidot syntax
+* Advanced autocomplete, suggestion and syntax engine to the Wikidot syntax
 * and many other features!
 
 <h2>
@@ -92,9 +97,19 @@ Author
 Donating
 </h2>
 
+* Buy me a coffee:
+
+<a href="https://www.buymeacoffee.com/mrnereof" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
+
 * Cryptocurrencies:
   * Binance Smart Chain (BSC) - 0x581cc7acbe921b1fa9fccbbfe008c86f68bc097d (BTC, ETH, DOGE and etc.)
 
+## Sponsors
+
+Skippy would like to thank the following organizations for graciously permitting us to use their services for free:
+
+* [JetBrains](https://www.jetbrains.com/pycharm/) ([info](https://www.jetbrains.com/community/opensource/#support))
+
 <h2>
 License
 </h2>

nsis/compile.bat

@@ -1,3 +1,5 @@
+@ECHO OFF
+
 python -m venv venv
 
 venv\Scripts\python -m pip install ../../pyscp

requirements.txt

@@ -1,7 +1,8 @@
 pypresence==4.2.0
 requests==2.25.1
 prettytable==2.0.0
-pyscp>=1.1.19
-pyftml>=0.1.2
+pyscp==1.1.19
+pyftml==0.1.2
 PyQt5==5.15.5
-PyQtWebEngine==5.15.4
+PyQtWebEngine==5.15.5
+toml==0.10.2

setup.py

@@ -55,13 +55,15 @@ def _get_constant(name: str) -> Any:
     url="https://github.com/skippy-dev/skippy/",
     author=_get_constant("author"),
     author_email=_get_constant("email"),
-    python_requires=">=3.9",
+    python_requires=">=3.7",
     license=_get_constant("license"),
     classifiers=[
         "Development Status :: 3 - Alpha",
         "Intended Audience :: Other Audience",
         "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
         "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
     ],
     keywords=["scp", "wikidot", "pyscp", "skippy"],
@@ -72,7 +74,7 @@ def _get_constant(name: str) -> Any:
         "skippy": [
             "resources/*",
             "resources/*/*",
-            "lang/*.json",
+            "lang/*.toml"
         ]
     },
     entry_points={

skippy/__init__.py

@@ -1,5 +1,5 @@
 __author__ = "MrNereof"
 __license__ = "GPLv3"
 __email__ = "mrnereof@gmail.com"
-__version__ = "1.2.3"
+__version__ = "1.2.4"
 __description__ = "Simple. Comfortable. Powerful. notepad for www.scpwiki.com."

skippy/api/types.py

@@ -1,16 +1,22 @@
-from typing import NamedTuple, TypedDict, Callable, Optional, Tuple, Dict, List, Any
+from typing import MutableMapping, NamedTuple, TypedDict, Callable, Optional, Tuple, Dict, List, Any
 
 
 class Language(NamedTuple):
     code: str
-    dictionary: Dict[str, str]
+    dictionary: MutableMapping[str, Any]
+
+
+class Field(NamedTuple):
+    tag: str
+    name: str
+    description: str
 
 
 class Action(NamedTuple):
     label: str
     statusTip: str
     func: Callable[..., Any]
-    img: str
+    img: Optional[str] = None
 
 
 class InlineSyntax(NamedTuple):
@@ -33,4 +39,4 @@ class PageData(TypedDict):
     link: Optional[Tuple[str, str]]
 
 
-__all__ = ["Language", "Action", "InlineSyntax", "BlockSyntax", "PageData"]
+__all__ = ["Language", "Field", "Action", "InlineSyntax", "BlockSyntax", "PageData"]

skippy/app.py

@@ -91,8 +91,11 @@ def plugins(self):
 
         print(table)
 
-    def start_ui(self):
+    def start_ui(self) -> int:
         """Initialize everything and run the application.
+
+        Returns:
+            int: Exit code
         """
         logger.log.setLevel(logger.LOG_LEVELS[self.args.logging_level])
 
@@ -108,10 +111,10 @@ def start_ui(self):
         logger.log.info("Start plugins...")
         pluginLoader.start_plugins()
 
-        logger.log.info("Initializing Discord RPC..")
+        logger.log.info("Initializing Discord RPC...")
         rpc = discord_rpc.DiscordRPC()
 
-        logger.log.info("Connect Discord RPC..")
+        logger.log.info("Connect Discord RPC...")
         rpc.connect()
 
         logger.log.info("Initializing application...")
@@ -120,7 +123,7 @@ def start_ui(self):
         logger.log.info("Stop plugins...")
         pluginLoader.stop_plugins()
 
-        logger.log.info("Stop Discord RPC..")
+        logger.log.info("Stop Discord RPC...")
         rpc.close()
 
         return exit_code

skippy/config.py

@@ -35,3 +35,7 @@
     PROPERTY_FOLDER = os.path.join(APPDATA_FOLDER, "property")
 
     LOGS_FOLDER = os.path.join(APPDATA_FOLDER, "logs")
+
+    PLUGINS_SETTINGS_FOLDER = os.path.join(APPDATA_FOLDER, "plugins")
+
+PLUGINS_SETTINGS_FOLDER = os.path.join(PLUGINS_FOLDER, "settings")