Add entry point for the GUI (run swolfpy in terminal)

SwolfPy-Project · Feb 21, 2024 · db0a062 · db0a062
1 parent f6d4803
commit db0a062
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 6 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -2,6 +2,12 @@
 History
 =======
 
+1.3.0 (2024-02-20)
+------------------
+
+* Add entry point for the GUI (run swolfpy in terminal)
+
+
 1.2.0 (2023-07-30)
 ------------------
 

diff --git a/README.rst b/README.rst
@@ -145,9 +145,17 @@ Installation
 
         python
 
-8- Run swolfpy in python::
+8- Run swolfpy
 
-        import swolfpy as sp
-        sp.swolfpy()
+    - In terminal::
+
+          swolfpy
+          # or
+          python -m swolfpy
+
+    - In python::
+
+          import swolfpy as sp
+          sp.SwolfPy()
 
 .. endInstallation
diff --git a/pyproject.toml b/pyproject.toml
@@ -41,6 +41,9 @@ Homepage = "https://swolfpy-project.github.io/"
 Documentation = "https://swolfpy.readthedocs.io/en/latest/"
 "Source Code" = "https://github.com/SwolfPy-Project/swolfpy"
 
+[project.scripts]
+swolfpy = "swolfpy:SwolfPy"
+
 [tool.setuptools.dynamic]
 version = {attr = "swolfpy.__version__"}
 readme = {file = ["README.rst", "HISTORY.rst"]}

diff --git a/swolfpy/__init__.py b/swolfpy/__init__.py
@@ -26,13 +26,13 @@
     "Optimization",
     "Monte_Carlo",
     "MyQtApp",
-    "swolfpy",
+    "SwolfPy",
 ]
 
-__version__ = "1.2.0"
+__version__ = "1.3.0"
 
 
-class swolfpy:
+class SwolfPy:
     def __init__(self):
         if not QtWidgets.QApplication.instance():
             self.app = QtWidgets.QApplication(sys.argv)

diff --git a/swolfpy/__main__.py b/swolfpy/__main__.py
@@ -0,0 +1,4 @@
+from . import SwolfPy
+
+if __name__ == "__main__":
+    SwolfPy()