service-config-foundry 0.1__tar.gz

service-config-foundry-0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Yush Raj Kapoor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

service-config-foundry-0.1/PKG-INFO

@@ -0,0 +1,304 @@
+Metadata-Version: 2.1
+Name: service-config-foundry
+Version: 0.1
+Summary: Helps create non-templated systemd services.
+Home-page: https://github.com/yushdotkapoor/service-config-foundry
+Author: Yush Kapoor
+Author-email: yushdotkapoor@gmail.com
+License: UNKNOWN
+Project-URL: Bug Tracker, https://github.com/yushdotkapoor/service-config-foundry/issues
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# service-config-foundry
+
+**service-config-foundry** is a Python-based library that simplifies the process of creating, updating, replacing, and deleting systemd service files for Linux users. With this tool, you can easily manage systemd services programmatically, reducing the complexity of writing and maintaining service configuration files manually.
+
+## Features
+
+- Create and manage non-templated systemd service files
+- Support for various systemd file types including `.service`, `.timer`, `.socket`, `.mount`, and more
+- Programmatic control over file attributes and configurations
+- Replace and update existing services without conflicts
+- Fully integrated Python API with no external dependencies
+
+## Installation
+
+You can install the library using `pip` directly from the GitHub repository:
+
+```bash
+pip install git+https://github.com/yushdotkapoor/service-config-foundry.git
+```
+
+Alternatively, clone the repository to get started:
+
+```bash
+git clone https://github.com/yushdotkapoor/service-config-foundry.git
+cd service-config-foundry
+```
+
+## Usage
+
+Below are detailed examples of how to use `service-config-foundry` to create and manage systemd files of various types.
+
+### Example: Creating a Service, Timer, and Socket
+
+```python
+from service import Service
+from service_location import ServiceLocation
+
+# Create a new service instance
+service = Service("example", service_location=ServiceLocation.GLOBAL, auto_start=False, enable_at_startup=False, force_overwrite=False)
+
+# Configure the service file
+service_file = service.service_file
+service_file.unit.description = "Example service for demonstration purposes"
+service_file.service.user = "yushrajkapoor"
+service_file.service.exec_start = "echo Hello, world >> /tmp/example.log"
+service_file.install.wanted_by = "multi-user.target"
+
+# Configure the timer file
+timer_file = service.timer_file
+timer_file.unit.description = "Example timer for demonstration purposes"
+timer_file.timer.on_calendar = "*-*-* *:00:00"
+timer_file.install.wanted_by = "timers.target"
+
+# Configure the socket file
+socket_file = service.socket_file
+socket_file.unit.description = "Example socket for demonstration purposes"
+socket_file.socket.listen_stream = "/run/example.sock"
+socket_file.install.wanted_by = "sockets.target"
+
+# Create or update the service, timer, and socket files
+service.update()
+
+# Enable the service to start at boot time
+service.enable_service_at_startup()
+
+# Start the service
+service.start_service()
+
+# Display the status of the service
+service.status()
+```
+
+### Output Files
+
+#### `example.service`
+```ini
+[Unit]
+Description = Example service for demonstration purposes
+
+[Service]
+User = yushrajkapoor
+ExecStart = echo Hello, world >> /tmp/example.log
+
+[Install]
+WantedBy = multi-user.target
+```
+
+#### `example.timer`
+```ini
+[Unit]
+Description = Example timer for demonstration purposes
+
+[Timer]
+OnCalendar = *-*-* *:00:00
+
+[Install]
+WantedBy = timers.target
+```
+
+#### `example.socket`
+```ini
+[Unit]
+Description = Example socket for demonstration purposes
+
+[Socket]
+ListenStream = /run/example.sock
+
+[Install]
+WantedBy = sockets.target
+```
+
+### Example: Replacing an Existing Service
+
+If you want to replace an existing service configuration, you can use the `replace()` method. This ensures that any old files are removed and replaced with the new configuration.
+
+```python
+# Replace the existing service configuration
+service.replace()
+```
+
+This is particularly useful when you want to ensure that your updates overwrite any conflicting configurations from previous versions of the service.
+
+### Example: Creating Mount and Automount Files
+
+```python
+# Configure the mount file
+mount_file = service.mount_file
+mount_file.unit.description = "Example mount for demonstration purposes"
+mount_file.mount.what = "/dev/sda1"
+mount_file.mount.where = "/mnt/example"
+mount_file.mount.type = "ext4"
+mount_file.install.wanted_by = "multi-user.target"
+
+# Configure the automount file
+automount_file = service.automount_file
+automount_file.unit.description = "Example automount for demonstration purposes"
+automount_file.automount.where = "/mnt/example"
+automount_file.install.wanted_by = "multi-user.target"
+
+# Create or update the files
+service.update()
+```
+
+#### `example.mount`
+```ini
+[Unit]
+Description = Example mount for demonstration purposes
+
+[Mount]
+What = /dev/sda1
+Where = /mnt/example
+Type = ext4
+
+[Install]
+WantedBy = multi-user.target
+```
+
+#### `example.automount`
+```ini
+[Unit]
+Description = Example automount for demonstration purposes
+
+[Automount]
+Where = /mnt/example
+
+[Install]
+WantedBy = multi-user.target
+```
+
+### Example: Creating Swap and Path Files
+
+```python
+# Configure the swap file
+swap_file = service.swap_file
+swap_file.unit.description = "Example swap for demonstration purposes"
+swap_file.swap.what = "/swapfile"
+swap_file.install.wanted_by = "multi-user.target"
+
+# Configure the path file
+path_file = service.path_file
+path_file.unit.description = "Example path for demonstration purposes"
+path_file.path.path_exists = "/tmp/example"
+path_file.install.wanted_by = "multi-user.target"
+
+# Create or update the files
+service.update()
+```
+
+#### `example.swap`
+```ini
+[Unit]
+Description = Example swap for demonstration purposes
+
+[Swap]
+What = /swapfile
+
+[Install]
+WantedBy = multi-user.target
+```
+
+#### `example.path`
+```ini
+[Unit]
+Description = Example path for demonstration purposes
+
+[Path]
+PathExists = /tmp/example
+
+[Install]
+WantedBy = multi-user.target
+```
+
+### Example: Creating Slice and Scope Files
+
+```python
+# Configure the slice file
+slice_file = service.slice_file
+slice_file.unit.description = "Example slice for demonstration purposes"
+
+# Configure the scope file
+scope_file = service.scope_file
+scope_file.unit.description = "Example scope for demonstration purposes"
+scope_file.scope.slice = "example.slice"
+
+# Create or update the files
+service.update()
+```
+
+#### `example.slice`
+```ini
+[Unit]
+Description = Example slice for demonstration purposes
+```
+
+#### `example.scope`
+```ini
+[Unit]
+Description = Example scope for demonstration purposes
+
+[Scope]
+Slice = example.slice
+```
+
+### Deleting a Service
+
+To delete a service and its associated files:
+
+```python
+service.delete()
+```
+
+This will remove all files matching the service name in the systemd directory.
+
+## Configuration Options
+
+`service-config-foundry` supports multiple systemd file types, including:
+
+- `.service` - Main service configuration
+- `.socket` - Socket configuration
+- `.timer` - Timer configuration
+- `.mount` - Mount point configuration
+- `.automount` - Automount configuration
+- `.swap` - Swap space configuration
+- `.path` - Path configuration
+- `.slice` - Slice configuration
+- `.scope` - Scope configuration
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
+
+## Contributing
+
+Contributions are welcome! If you encounter any issues or have suggestions for improvement, please open an issue or submit a pull request.
+
+## Contact
+
+- **Author**: Yush Kapoor  
+- **Email**: [yushdotkapoor@gmail.com](mailto:yushdotkapoor@gmail.com)  
+- **GitHub**: [https://github.com/yushdotkapoor/service-config-foundry](https://github.com/yushdotkapoor/service-config-foundry)
+
+## Acknowledgments
+
+Special thanks to the Linux and Python communities for their inspiration and support in creating this project.
+
+

service-config-foundry-0.1/README.md

@@ -0,0 +1,284 @@
+# service-config-foundry
+
+**service-config-foundry** is a Python-based library that simplifies the process of creating, updating, replacing, and deleting systemd service files for Linux users. With this tool, you can easily manage systemd services programmatically, reducing the complexity of writing and maintaining service configuration files manually.
+
+## Features
+
+- Create and manage non-templated systemd service files
+- Support for various systemd file types including `.service`, `.timer`, `.socket`, `.mount`, and more
+- Programmatic control over file attributes and configurations
+- Replace and update existing services without conflicts
+- Fully integrated Python API with no external dependencies
+
+## Installation
+
+You can install the library using `pip` directly from the GitHub repository:
+
+```bash
+pip install git+https://github.com/yushdotkapoor/service-config-foundry.git
+```
+
+Alternatively, clone the repository to get started:
+
+```bash
+git clone https://github.com/yushdotkapoor/service-config-foundry.git
+cd service-config-foundry
+```
+
+## Usage
+
+Below are detailed examples of how to use `service-config-foundry` to create and manage systemd files of various types.
+
+### Example: Creating a Service, Timer, and Socket
+
+```python
+from service import Service
+from service_location import ServiceLocation
+
+# Create a new service instance
+service = Service("example", service_location=ServiceLocation.GLOBAL, auto_start=False, enable_at_startup=False, force_overwrite=False)
+
+# Configure the service file
+service_file = service.service_file
+service_file.unit.description = "Example service for demonstration purposes"
+service_file.service.user = "yushrajkapoor"
+service_file.service.exec_start = "echo Hello, world >> /tmp/example.log"
+service_file.install.wanted_by = "multi-user.target"
+
+# Configure the timer file
+timer_file = service.timer_file
+timer_file.unit.description = "Example timer for demonstration purposes"
+timer_file.timer.on_calendar = "*-*-* *:00:00"
+timer_file.install.wanted_by = "timers.target"
+
+# Configure the socket file
+socket_file = service.socket_file
+socket_file.unit.description = "Example socket for demonstration purposes"
+socket_file.socket.listen_stream = "/run/example.sock"
+socket_file.install.wanted_by = "sockets.target"
+
+# Create or update the service, timer, and socket files
+service.update()
+
+# Enable the service to start at boot time
+service.enable_service_at_startup()
+
+# Start the service
+service.start_service()
+
+# Display the status of the service
+service.status()
+```
+
+### Output Files
+
+#### `example.service`
+```ini
+[Unit]
+Description = Example service for demonstration purposes
+
+[Service]
+User = yushrajkapoor
+ExecStart = echo Hello, world >> /tmp/example.log
+
+[Install]
+WantedBy = multi-user.target
+```
+
+#### `example.timer`
+```ini
+[Unit]
+Description = Example timer for demonstration purposes
+
+[Timer]
+OnCalendar = *-*-* *:00:00
+
+[Install]
+WantedBy = timers.target
+```
+
+#### `example.socket`
+```ini
+[Unit]
+Description = Example socket for demonstration purposes
+
+[Socket]
+ListenStream = /run/example.sock
+
+[Install]
+WantedBy = sockets.target
+```
+
+### Example: Replacing an Existing Service
+
+If you want to replace an existing service configuration, you can use the `replace()` method. This ensures that any old files are removed and replaced with the new configuration.
+
+```python
+# Replace the existing service configuration
+service.replace()
+```
+
+This is particularly useful when you want to ensure that your updates overwrite any conflicting configurations from previous versions of the service.
+
+### Example: Creating Mount and Automount Files
+
+```python
+# Configure the mount file
+mount_file = service.mount_file
+mount_file.unit.description = "Example mount for demonstration purposes"
+mount_file.mount.what = "/dev/sda1"
+mount_file.mount.where = "/mnt/example"
+mount_file.mount.type = "ext4"
+mount_file.install.wanted_by = "multi-user.target"
+
+# Configure the automount file
+automount_file = service.automount_file
+automount_file.unit.description = "Example automount for demonstration purposes"
+automount_file.automount.where = "/mnt/example"
+automount_file.install.wanted_by = "multi-user.target"
+
+# Create or update the files
+service.update()
+```
+
+#### `example.mount`
+```ini
+[Unit]
+Description = Example mount for demonstration purposes
+
+[Mount]
+What = /dev/sda1
+Where = /mnt/example
+Type = ext4
+
+[Install]
+WantedBy = multi-user.target
+```
+
+#### `example.automount`
+```ini
+[Unit]
+Description = Example automount for demonstration purposes
+
+[Automount]
+Where = /mnt/example
+
+[Install]
+WantedBy = multi-user.target
+```
+
+### Example: Creating Swap and Path Files
+
+```python
+# Configure the swap file
+swap_file = service.swap_file
+swap_file.unit.description = "Example swap for demonstration purposes"
+swap_file.swap.what = "/swapfile"
+swap_file.install.wanted_by = "multi-user.target"
+
+# Configure the path file
+path_file = service.path_file
+path_file.unit.description = "Example path for demonstration purposes"
+path_file.path.path_exists = "/tmp/example"
+path_file.install.wanted_by = "multi-user.target"
+
+# Create or update the files
+service.update()
+```
+
+#### `example.swap`
+```ini
+[Unit]
+Description = Example swap for demonstration purposes
+
+[Swap]
+What = /swapfile
+
+[Install]
+WantedBy = multi-user.target
+```
+
+#### `example.path`
+```ini
+[Unit]
+Description = Example path for demonstration purposes
+
+[Path]
+PathExists = /tmp/example
+
+[Install]
+WantedBy = multi-user.target
+```
+
+### Example: Creating Slice and Scope Files
+
+```python
+# Configure the slice file
+slice_file = service.slice_file
+slice_file.unit.description = "Example slice for demonstration purposes"
+
+# Configure the scope file
+scope_file = service.scope_file
+scope_file.unit.description = "Example scope for demonstration purposes"
+scope_file.scope.slice = "example.slice"
+
+# Create or update the files
+service.update()
+```
+
+#### `example.slice`
+```ini
+[Unit]
+Description = Example slice for demonstration purposes
+```
+
+#### `example.scope`
+```ini
+[Unit]
+Description = Example scope for demonstration purposes
+
+[Scope]
+Slice = example.slice
+```
+
+### Deleting a Service
+
+To delete a service and its associated files:
+
+```python
+service.delete()
+```
+
+This will remove all files matching the service name in the systemd directory.
+
+## Configuration Options
+
+`service-config-foundry` supports multiple systemd file types, including:
+
+- `.service` - Main service configuration
+- `.socket` - Socket configuration
+- `.timer` - Timer configuration
+- `.mount` - Mount point configuration
+- `.automount` - Automount configuration
+- `.swap` - Swap space configuration
+- `.path` - Path configuration
+- `.slice` - Slice configuration
+- `.scope` - Scope configuration
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
+
+## Contributing
+
+Contributions are welcome! If you encounter any issues or have suggestions for improvement, please open an issue or submit a pull request.
+
+## Contact
+
+- **Author**: Yush Kapoor  
+- **Email**: [yushdotkapoor@gmail.com](mailto:yushdotkapoor@gmail.com)  
+- **GitHub**: [https://github.com/yushdotkapoor/service-config-foundry](https://github.com/yushdotkapoor/service-config-foundry)
+
+## Acknowledgments
+
+Special thanks to the Linux and Python communities for their inspiration and support in creating this project.

service-config-foundry-0.1/service_config_foundry/__init__.py

@@ -0,0 +1,3 @@
+from .service import *
+
+__version__ = "0.1"

service-config-foundry-0.1/service_config_foundry/config_parser.py

@@ -0,0 +1,74 @@
+from configparser import ConfigParser
+from collections import defaultdict, OrderedDict
+
+
+class CaseSensitiveConfigParser(ConfigParser):
+    def __init__(self, *args, **kwargs):
+        # Disable interpolation to prevent issues with list values
+        kwargs['interpolation'] = None
+        super().__init__(*args, **kwargs)
+        self._dict = OrderedDict
+
+    def optionxform(self, optionstr):
+        # Preserve case sensitivity for option names
+        return optionstr
+
+    def _read(self, fp, fpname):
+        """Override _read to allow duplicate keys."""
+        cur_section = None
+        for lineno, line in enumerate(fp, start=1):
+            comment_start = line.find("#")
+            if comment_start != -1:
+                line = line[:comment_start]
+            line = line.strip()
+            if not line:
+                continue
+            if line.startswith("[") and line.endswith("]"):
+                cur_section = line[1:-1].strip()
+                if cur_section not in self._sections:
+                    self._sections[cur_section] = defaultdict(list)
+            else:
+                if cur_section is None:
+                    raise ValueError(f"Missing section header in {fpname} at line {lineno}")
+                key, _, value = line.partition("=")
+                key = key.strip()
+                value = value.strip()
+                self._sections[cur_section][key].append(value)
+
+    def get(self, section, option, *, raw=False, vars=None, fallback=None):
+        """Override `get` to handle list values."""
+        if section not in self._sections:
+            if fallback is not None:
+                return fallback
+            raise KeyError(f"Section '{section}' not found")
+        if option not in self._sections[section]:
+            if fallback is not None:
+                return fallback
+            raise KeyError(f"Option '{option}' not found in section '{section}'")
+
+        values = self._sections[section][option]
+        if isinstance(values, list):
+            # Join list values into a single string for compatibility
+            return "\n".join(values) if not raw else values
+        return values
+
+    def items(self, section=None, *, raw=False, vars=None):
+        """Override items to handle list values for both section-specific and global cases."""
+        if section is None:
+            # Global case: return all sections and their items
+            return [(s, dict(self.items(s))) for s in self._sections]
+        if section not in self._sections:
+            raise KeyError(f"Section '{section}' not found")
+        # Section-specific case: return all key-value pairs in the section
+        return ((key, "\n".join(values) if isinstance(values, list) else values)
+                for key, values in self._sections[section].items())
+
+
+    def write(self, fp):
+        """Override the write method to handle lists for duplicate keys."""
+        for section in self._sections:
+            fp.write(f"[{section}]\n")
+            for key, values in self._sections[section].items():
+                for value in values:
+                    fp.write(f"{key} = {value}\n")
+            fp.write("\n")