Skip to main content

Jobslib is a library for launching Python tasks in parallel environment. Our use-case is. We have two datacenters (in near future three datacenters), in each datacenter is run server with some task. However only one task may be active at one time across all datacenters. Jobslib solves this problem.

Main features are:

  • Ancestor for class which holds configuration.

  • Ancestor for container for shared resources, e.g. database connection.

  • Ancestor for class with task.

  • Configurable either from configuration file or from environmet variables.

  • Liveness – mechanism for exporting informations about health state of the task. Jobslib includes implementation which uses Consul.

  • Metrics – mechanism for exporting metrics. Jobslib includes implementation which uses InfluxDB.

  • One Instance Lock – lock, which allowes only one running instance at the same time. Jobslib includes implementation which uses Consul.

Installation

Installation from source code:

$ git clone https://github.com/seznam/jobslib.git
$ cd jobslib
$ python setup.py install

Installation from PyPi:

$ pip install jobslib

Tox is used for testing:

$ git clone https://github.com/seznam/jobslib.git
$ cd jobslib
$ pip install tox
$ tox --skip-missing-interpreters

Usage

Task is launched from command line using runjob command:

$ runjob [-s SETTINGS] [--disable-one-instance] [--run-once]
         [--sleep-interval SLEEP_INTERVAL] [--run-interval RUN_INTERVAL]
         [--keep-lock]
         task_cls

# Pass settings module using -s argument
$ runjob -s myapp.settings myapp.task.HelloWorldTask --run-once

# Pass settings module using environment variable
$ export JOBSLIB_SETTINGS_MODULE="myapp.settings"
$ runjob myapp.task.HelloWorldTask --run-once

If you want to write your own task, inherit BaseTask class and override BaseTask.task() method. According to your requirements inherit and override Config and/or Context and set settings module.

class HelloWorldTask(BaseTask):

    name = 'helloworld'
    description = 'prints hello world'

    def task(self):
        sys.stdout.write('Hello World!\n')
        sys.stdout.flush()

License

3-clause BSD

Documentation

https://seznam.github.io/jobslib/

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jobslib-3.0.2.tar.gz (22.1 kB view details)

Uploaded Source

File details

Details for the file jobslib-3.0.2.tar.gz.

File metadata

  • Download URL: jobslib-3.0.2.tar.gz
  • Upload date:
  • Size: 22.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.4

File hashes

Hashes for jobslib-3.0.2.tar.gz
Algorithm Hash digest
SHA256 78461343f67a21a5363febb4b620ef107072e9a00b03c156da07f4d64bdcb294
MD5 99d2c13ab4677e509f0314e31e9741fa
BLAKE2b-256 ac76f20bd33ec40a8cfdc57358050c2f4ed9041076b6a35511ad57e831b73e9d

See more details on using hashes here.

Release history Release notifications | RSS feed

3.2.1

2 files

3.2.0

2 files

3.1.0

1 file

3.0.5

1 file

3.0.4

1 file

3.0.3

1 file

This release

3.0.2 This release

1 file

3.0.1

1 file

3.0.0

1 file

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