https://github.com/ParthS007/background

Runs things in the background.
https://github.com/ParthS007/background

background background-jobs jobs python tasks

Last synced: 16 days ago
JSON representation

Runs things in the background.

• Host: GitHub
• URL: https://github.com/ParthS007/background
• Owner: ParthS007
• Created: 2017-09-02T21:38:01.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-04-08T18:19:38.000Z (over 1 year ago)
• Last Synced: 2024-10-26T21:27:25.364Z (18 days ago)
• Topics: background, background-jobs, jobs, python, tasks
• Language: Python
• Size: 22.5 KB
• Stars: 511
• Watchers: 21
• Forks: 26
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
.. image:: https://img.shields.io/pypi/pyversions/background.svg

   :target: https://pypi.org/pypi/background

.. image:: https://github.com/ParthS007/background/workflows/CI/badge.svg

   :target: https://github.com/ParthS007/background/actions

Background

=======================================

It runs stuff in the background.

    "An elegant decorator-based abstraction around Python 3's concurrent.futures ThreadPoolExecutor class" 

    — Simon Willison

This module makes it stupidly simple to run things in the background of your

application, be it a CLI app, or a web app.

Basic Usage

-----------

.. code:: python

    import time

    import background

    @background.task

    def work():

        # Do something expensive here.

        time.sleep(10)

    for _ in range(100):

        work()

Advanced Usage

--------------

.. code:: python

    import time

    import background

    # Use 40 background threads.

    background.n = 40

    

    @background.task

    def work():

        time.sleep(10)

        return "Done!"

    @background.callback

    def work_callback(future):

        print(future.result())

    for _ in range(100):

        work()

Installation

------------

::

    $ pipenv install background

    ✨🍰✨