v0.7.2 (Use Salve)

salve-org · Jul 12, 2024 · 07ce8eb · 07ce8eb
1 parent 257d4db
commit 07ce8eb
Show file tree

Hide file tree

Showing 38 changed files with 34 additions and 34 deletions.
diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml
@@ -1,4 +1,4 @@
-name: Upload salve_ipc to Pypi
+name: Upload salve to Pypi
 
 on:
   release:

diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,4 @@ __pycache__/
 dist/
 build/
 .ruff_cache/
-salve_ipc.egg-info/
+salve.egg-info/
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-<h1 align="center">Salve v0.7.1</h1>
+<h1 align="center">Salve v0.7.2</h1>
 
 # Installation
 
-In the Command Line, paste the following: `pip install salve_ipc`
+In the Command Line, paste the following: `pip install salve`
 
 ## Description
 
@@ -21,8 +21,8 @@ To contribute, fork the repository, make your changes, and then make a pull requ
 
 ## Required Python Version: 3.11+
 
-Salve IPC will use the three most recent versions (full releases) going forward and will drop any older versions as new ones come out. This is because I hope to keep this package up to date with modern python versions as they come out instead of being forced to maintain decade old python versions.
-Currently 3.11 is the minimum (instead of 3.10) as Salve IPC was developed under 3.12 and there are many features that Salve IPC relies on from this version I want. However, after 3.14 is released, the minimum version will be 3.12 (as would be expected from the plan) and will change accordingly in the future as is described in the plan above.
+Salve will use the three most recent versions (full releases) going forward and will drop any older versions as new ones come out. This is because I hope to keep this package up to date with modern python versions as they come out instead of being forced to maintain decade old python versions.
+Currently 3.11 is the minimum (instead of 3.10) as Salve was developed under 3.12 and there are many features that Salve IPC relies on from this version I want. However, after 3.14 is released, the minimum version will be 3.12 (as would be expected from the plan) and will change accordingly in the future as is described in the plan above.
 
 ## License
 

diff --git a/docs/source/command-sheet.rst b/docs/source/command-sheet.rst
@@ -4,7 +4,7 @@ Command Sheet
 
 Below is a chart outlining the different request commands you can give and the different arguments they require with an explanation in parentheses if needed.
 
-.. list-table:: **IPC Commands**
+.. list-table:: **Requestable Commands**
     :widths: 25 75
     :header-rows: 1
 

diff --git a/docs/source/example-usage.rst b/docs/source/example-usage.rst
@@ -11,7 +11,7 @@ Now that you have ``Salve`` installed, let's try running a simple example that p
     # We import the IPC class, the HIGHLIGHT command, and the Response TypedDict
     # NOTE: The HIGHLIGHT is actually just a string but it makes it easier to get
     # spelling errors from your code editor
-    from salve_ipc import HIGHLIGHT, IPC, Response
+    from salve import HIGHLIGHT, IPC, Response
 
 
     # Because this module is made with multiprocessing we need any usage to
@@ -65,7 +65,7 @@ In a more realistic case, you would probably do something more like the followin
 
 .. code-block:: python
 
-    from salve_ipc import IPC, Response, HIGHLIGHT
+    from salve import IPC, Response, HIGHLIGHT
     from tkinter import Tk
 
     class App(Tk):

diff --git a/docs/source/examples/example_usage.rst b/docs/source/examples/example_usage.rst
@@ -8,7 +8,7 @@ Example Usage
     from selectors import EVENT_READ, DefaultSelector
     from sys import stdin, stdout
     
-    from salve_ipc import AUTOCOMPLETE, IPC, Response
+    from salve import AUTOCOMPLETE, IPC, Response
     
     
     def main():

diff --git a/docs/source/examples/gui_client.rst b/docs/source/examples/gui_client.rst
@@ -6,7 +6,7 @@ Gui Client
 
     from tkinter import Entry, Label, Tk
     
-    from salve_ipc import AUTOCOMPLETE, IPC, Response
+    from salve import AUTOCOMPLETE, IPC, Response
     
     
     def main():

diff --git a/docs/source/examples/simple_autocomplete_example.rst b/docs/source/examples/simple_autocomplete_example.rst
@@ -6,7 +6,7 @@ Simple Autocomplete Example
 
     from time import sleep
     
-    from salve_ipc import AUTOCOMPLETE, IPC, Response
+    from salve import AUTOCOMPLETE, IPC, Response
     
     
     def main():

diff --git a/docs/source/examples/simple_definitions_example.rst b/docs/source/examples/simple_definitions_example.rst
@@ -6,7 +6,7 @@ Simple Definitions Example
 
     from time import sleep
     
-    from salve_ipc import DEFINITION, IPC, Response
+    from salve import DEFINITION, IPC, Response
     
     
     def main():

diff --git a/docs/source/examples/simple_editorconfig_example.rst b/docs/source/examples/simple_editorconfig_example.rst
@@ -6,7 +6,7 @@ Simple Editorconfig Example
 
     from time import sleep
     
-    from salve_ipc import EDITORCONFIG, IPC, Response
+    from salve import EDITORCONFIG, IPC, Response
     
     
     def main():

diff --git a/docs/source/examples/simple_highlight_example.rst b/docs/source/examples/simple_highlight_example.rst
@@ -6,7 +6,7 @@ Simple Highlight Example
 
     from time import sleep
     
-    from salve_ipc import HIGHLIGHT, IPC, Response
+    from salve import HIGHLIGHT, IPC, Response
     
     
     def main():

diff --git a/docs/source/examples/simple_replacements_example.rst b/docs/source/examples/simple_replacements_example.rst
@@ -6,7 +6,7 @@ Simple Replacements Example
 
     from time import sleep
     
-    from salve_ipc import IPC, REPLACEMENTS, Response
+    from salve import IPC, REPLACEMENTS, Response
     
     
     def main():

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,8 +1,8 @@
-===========================
-``Salve IPC`` Documentation
-===========================
+=======================
+``Salve`` Documentation
+=======================
 
-Welcome to ``Salve IPC``'s Documentation! ``Salve IPC`` is a library that can be used by code editors to easily get autocompletions, replacements, editorconfig suggestions, definitions, and syntax highlighting. It does this with a simple yet very powerful API while doing all major work in a seperate process to keep the main thread free and fast. To get started with Salve, visit the :doc:`installation` page!
+Welcome to ``Salve``'s Documentation! ``Salve`` is a library that can be used by code editors to easily get autocompletions, replacements, editorconfig suggestions, definitions, and syntax highlighting. It does this with a simple yet very powerful API while doing all major work in a seperate process to keep the main thread free and fast. To get started with Salve, visit the :doc:`installation` page!
 
 .. note::
 

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -6,7 +6,7 @@ To start using ``Salve``, first install it using pip:
 
 .. code-block:: console
 
-    $ pip install salve-ipc
+    $ pip install salve
 
 And it's installed! Congratulations on giving your code editors the tools they need to work and allowing youself to not pull out hair in the process!
 

diff --git a/examples/example_usage.py b/examples/example_usage.py
@@ -2,7 +2,7 @@
 from selectors import EVENT_READ, DefaultSelector
 from sys import stdin, stdout
 
-from salve_ipc import AUTOCOMPLETE, IPC, Response
+from salve import AUTOCOMPLETE, IPC, Response
 
 
 def main():

diff --git a/examples/gui_client.py b/examples/gui_client.py
@@ -1,6 +1,6 @@
 from tkinter import Entry, Label, Tk
 
-from salve_ipc import AUTOCOMPLETE, IPC, Response
+from salve import AUTOCOMPLETE, IPC, Response
 
 
 def main():

diff --git a/examples/simple_autocomplete_example.py b/examples/simple_autocomplete_example.py
@@ -1,6 +1,6 @@
 from time import sleep
 
-from salve_ipc import AUTOCOMPLETE, IPC, Response
+from salve import AUTOCOMPLETE, IPC, Response
 
 
 def main():

diff --git a/examples/simple_definitions_example.py b/examples/simple_definitions_example.py
@@ -1,6 +1,6 @@
 from time import sleep
 
-from salve_ipc import DEFINITION, IPC, Response
+from salve import DEFINITION, IPC, Response
 
 
 def main():

diff --git a/examples/simple_editorconfig_example.py b/examples/simple_editorconfig_example.py
@@ -1,6 +1,6 @@
 from time import sleep
 
-from salve_ipc import EDITORCONFIG, IPC, Response
+from salve import EDITORCONFIG, IPC, Response
 
 
 def main():

diff --git a/examples/simple_highlight_example.py b/examples/simple_highlight_example.py
@@ -1,6 +1,6 @@
 from time import sleep
 
-from salve_ipc import HIGHLIGHT, IPC, Response
+from salve import HIGHLIGHT, IPC, Response
 
 
 def main():

diff --git a/examples/simple_replacements_example.py b/examples/simple_replacements_example.py
@@ -1,6 +1,6 @@
 from time import sleep
 
-from salve_ipc import IPC, REPLACEMENTS, Response
+from salve import IPC, REPLACEMENTS, Response
 
 
 def main():

diff --git a/salve_ipc/__init__.py → salve/__init__.py b/salve_ipc/__init__.py → salve/__init__.py
diff --git a/salve_ipc/ipc.py → salve/ipc.py b/salve_ipc/ipc.py → salve/ipc.py
diff --git a/salve_ipc/misc.py → salve/misc.py b/salve_ipc/misc.py → salve/misc.py
diff --git a/salve_ipc/server.py → salve/server.py b/salve_ipc/server.py → salve/server.py
diff --git a/salve_ipc/server_functions/__init__.py → salve/server_functions/__init__.py b/salve_ipc/server_functions/__init__.py → salve/server_functions/__init__.py
diff --git a/...e_ipc/server_functions/autocompletions.py → salve/server_functions/autocompletions.py b/...e_ipc/server_functions/autocompletions.py → salve/server_functions/autocompletions.py
diff --git a/salve_ipc/server_functions/definitions.py → salve/server_functions/definitions.py b/salve_ipc/server_functions/definitions.py → salve/server_functions/definitions.py
diff --git a/...pc/server_functions/highlight/__init__.py → salve/server_functions/highlight/__init__.py b/...pc/server_functions/highlight/__init__.py → salve/server_functions/highlight/__init__.py
diff --git a/...unctions/highlight/docstring_highlight.py → ...unctions/highlight/docstring_highlight.py b/...unctions/highlight/docstring_highlight.py → ...unctions/highlight/docstring_highlight.py
diff --git a/...c/server_functions/highlight/highlight.py → ...e/server_functions/highlight/highlight.py b/...c/server_functions/highlight/highlight.py → ...e/server_functions/highlight/highlight.py
diff --git a/...tions/highlight/links_and_hidden_chars.py → ...tions/highlight/links_and_hidden_chars.py b/...tions/highlight/links_and_hidden_chars.py → ...tions/highlight/links_and_hidden_chars.py
diff --git a/..._ipc/server_functions/highlight/tokens.py → salve/server_functions/highlight/tokens.py b/..._ipc/server_functions/highlight/tokens.py → salve/server_functions/highlight/tokens.py
diff --git a/salve_ipc/server_functions/misc.py → salve/server_functions/misc.py b/salve_ipc/server_functions/misc.py → salve/server_functions/misc.py
diff --git a/salve_ipc/server_functions/replacements.py → salve/server_functions/replacements.py b/salve_ipc/server_functions/replacements.py → salve/server_functions/replacements.py
diff --git a/setup.py b/setup.py
@@ -1,13 +1,13 @@
-# pip install -r requirements.txt --break-system-packages; pip uninstall salve_ipc -y --break-system-packages; pip install . --break-system-packages --no-build-isolation; python3 -m pytest .
+# pip install -r requirements.txt --break-system-packages; pip uninstall salve -y --break-system-packages; pip install . --break-system-packages --no-build-isolation; python3 -m pytest .
 from setuptools import setup
 
 with open("README.md", "r") as file:
     long_description = file.read()
 
 
 setup(
-    name="salve_ipc",
-    version="0.7.1",
+    name="salve",
+    version="0.7.2",
     description="Salve is an IPC library that can be used by code editors to easily get autocompletions, replacements, editorconfig suggestions, definitions, and syntax highlighting.",
     author="Moosems",
     author_email="[email protected]",
@@ -25,5 +25,5 @@
         "License :: OSI Approved :: MIT License",
         "Typing :: Typed",
     ],
-    packages=["salve_ipc"],
+    packages=["salve"],
 )
diff --git a/tests/test_defintions.py b/tests/test_defintions.py
@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from salve_ipc.server_functions import get_definition
+from salve.server_functions import get_definition
 
 
 def test_get_definition():

diff --git a/tests/test_ipc.py b/tests/test_ipc.py
@@ -2,7 +2,7 @@
 from sys import platform
 from time import sleep
 
-from salve_ipc import (
+from salve import (
     AUTOCOMPLETE,
     DEFINITION,
     EDITORCONFIG,