pyworkspace 0.1.0__tar.gz

pyworkspace-0.1.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: pyworkspace
+Version: 0.1.0
+Summary: A python workspace and session manager for Windows environments with hotkey support.
+Home-page: https://github.com/yourusername/pyworkspace
+Author: Your Name
+Author-email: your.email@example.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Environment :: Win32 (MS Windows)
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: keyboard>=0.13.5
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# PyWorkspace
+
+A sleek python package that acts as a Windows workspace and session manager. It allows you to group different files and programs together into a "Workspace" and manage them via a "Session". Executing the class method helps to open certain files/programs together and save them into a session file, allowing you to easily resume work after shutting down your PC.
+
+It also comes with a built-in background service that listens to global shortcut keys (e.g. `Ctrl + Shift + E` to open Explorer).
+
+## Installation
+
+```bash
+pip install pyworkspace
+```
+
+## Quick Start
+
+### Managing Workspaces Programmatically
+
+```python
+from pyworkspace import Workspace, Session
+
+# 1. Initialize a session manager
+session = Session("my_daily_session.json")
+
+# 2. Create a Workspace
+dev_ws = Workspace("Development")
+dev_ws.add_program(r"C:\Windows\System32\cmd.exe")
+dev_ws.add_file(r"C:\path\to\your\code.py")
+
+# 3. Add to session and save
+session.add_workspace(dev_ws)
+session.save()
+
+# 4. Resume
+session.resume()
+```
+
+### Running the Background Service
+
+Once installed, a console script is automatically generated for you. Run:
+```bash
+pyworkspace-service
+```
+This runs the background listener. Optionally, it can be launched via standard hidden `.vbs` scripts for true silent operation on login!
+
+## Requirements
+- Python 3.6+
+- Windows OS
+- `keyboard` library

pyworkspace-0.1.0/README.md

@@ -0,0 +1,47 @@
+# PyWorkspace
+
+A sleek python package that acts as a Windows workspace and session manager. It allows you to group different files and programs together into a "Workspace" and manage them via a "Session". Executing the class method helps to open certain files/programs together and save them into a session file, allowing you to easily resume work after shutting down your PC.
+
+It also comes with a built-in background service that listens to global shortcut keys (e.g. `Ctrl + Shift + E` to open Explorer).
+
+## Installation
+
+```bash
+pip install pyworkspace
+```
+
+## Quick Start
+
+### Managing Workspaces Programmatically
+
+```python
+from pyworkspace import Workspace, Session
+
+# 1. Initialize a session manager
+session = Session("my_daily_session.json")
+
+# 2. Create a Workspace
+dev_ws = Workspace("Development")
+dev_ws.add_program(r"C:\Windows\System32\cmd.exe")
+dev_ws.add_file(r"C:\path\to\your\code.py")
+
+# 3. Add to session and save
+session.add_workspace(dev_ws)
+session.save()
+
+# 4. Resume
+session.resume()
+```
+
+### Running the Background Service
+
+Once installed, a console script is automatically generated for you. Run:
+```bash
+pyworkspace-service
+```
+This runs the background listener. Optionally, it can be launched via standard hidden `.vbs` scripts for true silent operation on login!
+
+## Requirements
+- Python 3.6+
+- Windows OS
+- `keyboard` library

pyworkspace-0.1.0/pyworkspace/Session.py

@@ -0,0 +1,106 @@
+import os
+import json
+import subprocess
+from .Workspace import Workspace
+
+class Session:
+    """
+    Session helps manage and persist workspaces.
+    It can save the current configuration to a JSON file and resume it after a computer shutdown.
+    """
+    def __init__(self, session_file: str = "session.json"):
+        self.session_file = session_file
+        self.workspaces = {}
+
+    def add_workspace(self, workspace: Workspace):
+        """Add a Workspace object to the current session."""
+        self.workspaces[workspace.name] = workspace
+
+    def remove_workspace(self, workspace_name: str):
+        """Remove a Workspace from the current session by its name."""
+        if workspace_name in self.workspaces:
+            del self.workspaces[workspace_name]
+
+    def save(self):
+        """Save the session (all managed workspaces) to a JSON file on disk."""
+        data = {
+            'workspaces': {name: ws.to_dict() for name, ws in self.workspaces.items()}
+        }
+        with open(self.session_file, 'w', encoding='utf-8') as f:
+            json.dump(data, f, indent=4)
+        print(f"Session successfully saved to {self.session_file}")
+
+    def load(self):
+        """Load the session from the JSON file on disk."""
+        if not os.path.exists(self.session_file):
+            print(f"Session file '{self.session_file}' does not exist. Starting fresh.")
+            return
+
+        try:
+            with open(self.session_file, 'r', encoding='utf-8') as f:
+                data = json.load(f)
+            
+            self.workspaces.clear()
+            for name, ws_data in data.get('workspaces', {}).items():
+                self.workspaces[name] = Workspace.from_dict(ws_data)
+            print(f"Session loaded successfully from {self.session_file}")
+        except Exception as e:
+            print(f"Error loading session from {self.session_file}: {e}")
+
+    def open_workspace(self, workspace_name: str):
+        """Launch all programs and files associated with a specific workspace."""
+        if workspace_name not in self.workspaces:
+            print(f"Workspace '{workspace_name}' not found in the current session.")
+            return
+
+        ws = self.workspaces[workspace_name]
+        print(f"Opening Workspace: {ws.name}")
+        
+        # 1. Open all defined programs
+        for prog in ws.programs:
+            path = prog.get('path')
+            args = prog.get('args', '')
+            cwd = prog.get('cwd')
+            
+            if not os.path.exists(path):
+                print(f"  [Warning] Program missing: {path}")
+                continue
+                
+            cmd = [path]
+            if args:
+                cmd.extend(args.split())
+                
+            try:
+                print(f"  -> Starting program: {path}")
+                # We use subprocess.Popen to launch asynchronously so it doesn't block the Python script
+                subprocess.Popen(cmd, cwd=cwd or os.path.dirname(path))
+            except Exception as e:
+                print(f"  [Error] Failed to start {path}: {e}")
+
+        # 2. Open all defined files
+        for file_item in ws.files:
+            file_path = file_item.get('path')
+            if not os.path.exists(file_path):
+                print(f"  [Warning] File missing: {file_path}")
+                continue
+                
+            try:
+                print(f"  -> Opening file: {file_path}")
+                # os.startfile is built-in on Windows and behaves like double-clicking a file
+                if hasattr(os, 'startfile'):
+                    os.startfile(file_path)
+                else:
+                    # Fallback for non-Windows (just in case, although designed for Windows)
+                    subprocess.Popen(['start', '', file_path], shell=True)
+            except Exception as e:
+                print(f"  [Error] Failed to open {file_path}: {e}")
+
+    def resume(self):
+        """Load the session from disk and open all managed workspaces."""
+        self.load()
+        if not self.workspaces:
+            print("No workspaces to resume.")
+            return
+
+        for ws_name in self.workspaces:
+            self.open_workspace(ws_name)

pyworkspace-0.1.0/pyworkspace/Workspace.py

@@ -0,0 +1,48 @@
+import os
+
+class Workspace:
+    """
+    Workspace represents a collection of programs and files that belong together.
+    It stores their paths and arguments so they can be launched as a group.
+    """
+    def __init__(self, name: str):
+        self.name = name
+        self.programs = []
+        self.files = []
+
+    def add_program(self, path: str, args: str = "", cwd: str = None):
+        """
+        Add a program (executable) to the workspace.
+        
+        Args:
+            path: Absolute path to the executable.
+            args: Command line arguments for the program.
+            cwd: Working directory from which to launch the program.
+        """
+        self.programs.append({'path': path, 'args': args, 'cwd': cwd})
+
+    def add_file(self, file_path: str):
+        """
+        Add a specific file to be opened in the workspace.
+        It will be opened with its default associated application in Windows.
+        
+        Args:
+            file_path: Absolute path to the file.
+        """
+        self.files.append({'path': file_path})
+
+    def to_dict(self) -> dict:
+        """Convert workspace to dictionary for serialization."""
+        return {
+            'name': self.name,
+            'programs': self.programs,
+            'files': self.files
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict) -> 'Workspace':
+        """Create a workspace instance from a dictionary."""
+        ws = cls(data['name'])
+        ws.programs = data.get('programs', [])
+        ws.files = data.get('files', [])
+        return ws

pyworkspace-0.1.0/pyworkspace/__init__.py

@@ -0,0 +1,6 @@
+__version__ = "0.1.0"
+
+from .Workspace import Workspace
+from .Session import Session
+
+__all__ = ["Workspace", "Session"]

pyworkspace-0.1.0/pyworkspace/service.py

@@ -0,0 +1,35 @@
+import os
+import sys
+
+def open_explorer():
+    """
+    Callback function to execute when the hotkey is pressed.
+    Opens the default Windows Explorer.
+    """
+    try:
+        # Opens explorer at the default 'My Computer' / 'Quick Access' location
+        os.startfile('explorer.exe')
+    except Exception as e:
+        print(f"Error opening explorer: {e}")
+
+def main():
+    try:
+        import keyboard
+    except ImportError:
+        print("The 'keyboard' library is required.")
+        print("Please install it running: pip install keyboard")
+        sys.exit(1)
+
+    # 1. Register the hotkey combinations
+    # You can bind the hotkey to the function created above.
+    keyboard.add_hotkey('ctrl+shift+e', open_explorer)
+    
+    # Example: You can bind other shortcuts for pyworkspace class methods
+    # e.g., keyboard.add_hotkey('ctrl+shift+w', session.resume)
+
+    # 2. Block the script from exiting and run indefinitely
+    # The script will listen in the background until 'ctrl+shift+q' is pressed.
+    keyboard.wait('ctrl+shift+q')
+
+if __name__ == '__main__':
+    main()

pyworkspace-0.1.0/pyworkspace.egg-info/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: pyworkspace
+Version: 0.1.0
+Summary: A python workspace and session manager for Windows environments with hotkey support.
+Home-page: https://github.com/yourusername/pyworkspace
+Author: Your Name
+Author-email: your.email@example.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Environment :: Win32 (MS Windows)
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: keyboard>=0.13.5
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# PyWorkspace
+
+A sleek python package that acts as a Windows workspace and session manager. It allows you to group different files and programs together into a "Workspace" and manage them via a "Session". Executing the class method helps to open certain files/programs together and save them into a session file, allowing you to easily resume work after shutting down your PC.
+
+It also comes with a built-in background service that listens to global shortcut keys (e.g. `Ctrl + Shift + E` to open Explorer).
+
+## Installation
+
+```bash
+pip install pyworkspace
+```
+
+## Quick Start
+
+### Managing Workspaces Programmatically
+
+```python
+from pyworkspace import Workspace, Session
+
+# 1. Initialize a session manager
+session = Session("my_daily_session.json")
+
+# 2. Create a Workspace
+dev_ws = Workspace("Development")
+dev_ws.add_program(r"C:\Windows\System32\cmd.exe")
+dev_ws.add_file(r"C:\path\to\your\code.py")
+
+# 3. Add to session and save
+session.add_workspace(dev_ws)
+session.save()
+
+# 4. Resume
+session.resume()
+```
+
+### Running the Background Service
+
+Once installed, a console script is automatically generated for you. Run:
+```bash
+pyworkspace-service
+```
+This runs the background listener. Optionally, it can be launched via standard hidden `.vbs` scripts for true silent operation on login!
+
+## Requirements
+- Python 3.6+
+- Windows OS
+- `keyboard` library

pyworkspace-0.1.0/pyworkspace.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+setup.py
+pyworkspace/Session.py
+pyworkspace/Workspace.py
+pyworkspace/__init__.py
+pyworkspace/service.py
+pyworkspace.egg-info/PKG-INFO
+pyworkspace.egg-info/SOURCES.txt
+pyworkspace.egg-info/dependency_links.txt
+pyworkspace.egg-info/entry_points.txt
+pyworkspace.egg-info/requires.txt
+pyworkspace.egg-info/top_level.txt

pyworkspace-0.1.0/pyworkspace.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyworkspace-0.1.0/pyworkspace.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pyworkspace-service = pyworkspace.service:main

pyworkspace-0.1.0/pyworkspace.egg-info/requires.txt

@@ -0,0 +1 @@
+keyboard>=0.13.5

pyworkspace-0.1.0/pyworkspace.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyworkspace

pyworkspace-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyworkspace-0.1.0/setup.py

@@ -0,0 +1,35 @@
+from setuptools import setup, find_packages
+import os
+
+# Read the contents of your README file
+this_directory = os.path.abspath(os.path.dirname(__file__))
+with open(os.path.join(this_directory, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(
+    name="pyworkspace", # You may need to change this if the name is already taken on PyPI
+    version="0.1.0",
+    author="Your Name",
+    author_email="your.email@example.com",
+    description="A python workspace and session manager for Windows environments with hotkey support.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/yourusername/pyworkspace",
+    packages=find_packages(),
+    install_requires=[
+        "keyboard>=0.13.5",
+    ],
+    # This creates a command line executable, so users can just type 'pyworkspace-service'
+    entry_points={
+        'console_scripts': [
+            'pyworkspace-service=pyworkspace.service:main',
+        ],
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: Microsoft :: Windows",
+        "Environment :: Win32 (MS Windows)",
+    ],
+    python_requires='>=3.6',
+)