Skip to main content
Travis build status image Coverage status

succubus

Description

succubus is a lightweight python module for a fast and easy creation of python daemons and init scripts.

Examples

#!/usr/bin/env python

import logging
import sys
import time

from logging.handlers import WatchedFileHandler

from succubus import Daemon


class MyDaemon(Daemon):
    def run(self):
        """Overwrite the run function of the Daemon class"""
        while True:
            time.sleep(1)
            self.logger.warn('Hello world')

    def setup_logging(self):
        # TODO: don't log to /tmp except for example code
        handler = WatchedFileHandler('/tmp/succubus.log')
        self.logger = logging.getLogger('succubus')
        self.logger.addHandler(handler)


def main():
    daemon = MyDaemon(pid_file='succubus.pid')
    sys.exit(daemon.action())


if __name__ == '__main__':
    main()

Succubus implements the usual init script actions (start, stop, restart, status) in Python. So your init script can look like this:

#!/bin/bash
/usr/bin/my_succubus_daemon $1 --foo=42

If the init script is called as /etc/init.d/my_succubus_daemon start, this will translate into /usr/bin/my_succubus_daemon start --foo=42 being called. The start parameter is consumed by the succubus framework, i.e. when your code does the command line parsing, it looks as if /usr/bin/my_succubus_daemon --foo=42 was called. You can now parse the --foo=42 parameter as you please.

Release files for succubus 1.0.post241

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for succubus 1.0.post241
File Size Uploaded
succubus-1.0.post241.tar.gz 4.6 kB Details

Release files / succubus-1.0.post241.tar.gz

Download URL succubus-1.0.post241.tar.gz
Size 4.6 kB
Tags Source
SHA-256 checksum
How to use checksums
4eb115a3ecad3482250cf25eb4f2cdc2d6fe7253e3fa7be7deb1183f29403d76
BLAKE2b-256 checksum
How to use checksums
b448914fe25b5621010a388b0e86cb860931ed7b5eea8a8e2e49ff1d3b94e29f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

1.0.post241 This release

1 release file

1.0-55

1 release file

1.0-54

1 release file

1.0-53

1 release file

1.0-52

1 release file

1.0-51

1 release file

1.0-50

1 release file

1.0-49

1 release file

1.0-48

1 release file

1.0-47

1 release file

1.0-46

1 release file

1.0-45

1 release file

1.0-38

1 release file

1.0-37

1 release file

1.0-36

1 release file

1.0-35

1 release file

1.0-34

1 release file

1.0-33

1 release file

1.0-31

1 release file

1.0-30

1 release file

1.0-29

1 release file

1.0-28

1 release file

1.0-27

1 release file

1.0-26

1 release file

1.0-25

1 release file

1.0-24

1 release file

1.0-22

1 release file

1.0-21

1 release file

1.0-20

1 release file

1.0-19

1 release file

1.0-18

1 release file

1.0-17

1 release file

1.0-15

1 release file

1.0-14

1 release file

1.0-13

1 release file

1.0-12

1 release file

1.0-11

1 release file

1.0-10

1 release file

1.0-9

1 release file

1.0-8

1 release file

1.0-7

1 release file

1.0-6

1 release file

1.0-5

1 release file

1.0-4

1 release file

1.0-3

1 release file

1.0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page