aiocronjob


Nameaiocronjob JSON
Version 0.7.0 PyPI version JSON
download
home_page
SummarySchedule async tasks and manage them using a REST API or WEB UI
upload_time2022-12-31 16:51:19
maintainer
docs_urlNone
author
requires_python>=3.8
licenseMIT
keywords async tasks crontab rest api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # aiocronjob

[![Join the chat at https://gitter.im/aiocronjob/community](https://badges.gitter.im/aiocronjob/community.svg)](https://gitter.im/aiocronjob/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aiocronjob?style=flat-square)
![PyPI](https://img.shields.io/pypi/v/aiocronjob?style=flat-square)
![PyPI - License](https://img.shields.io/pypi/l/aiocronjob?style=flat-square)
![GitHub last commit](https://img.shields.io/github/last-commit/devtud/aiocronjob?style=flat-square)
![PyPI - Status](https://img.shields.io/pypi/status/aiocronjob?style=flat-square)
[![Tests](https://github.com/devtud/aiocronjob/actions/workflows/tests.yml/badge.svg)](https://github.com/devtud/aiocronjob/actions/workflows/tests.yml)
[![Codecov](https://codecov.io/gh/devtud/aiocronjob/branch/main/graph/badge.svg)](https://codecov.io/gh/devtud/aiocronjob)

Schedule and run `asyncio` coroutines and manage them from a web interface or programmatically using the rest api.

### Requires python >= 3.8

### How to install

```bash
pip3 install aiocronjob
```

### Usage example

See [examples/simple_tasks.py](https://github.com/devtud/aiocronjob/blob/master/examples/simple_tasks.py)

#### Rest API

Open [localhost:8000/docs](http://localhost:8000/docs) for endpoints docs.

**`curl`** example:
 
```bash
$ curl http://0.0.0.0:8000/api/jobs
```
```json
TBD
```

### Development

**Requirements**:
- **Python** >= 3.8 and **PDM** for backend


#### Install dependencies

```bash
$ git clone https://github.com/devtud/aiocronjob.git

$ cd aiocronjob

$ pdm sync
```

#### Run tests

```bash
pdm run coverage run -m unittest discover

pdm run coverage report -m
```


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "aiocronjob",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "devtud <devtud@gmail.com>",
    "keywords": "async tasks,crontab,rest api",
    "author": "",
    "author_email": "devtud <devtud@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/7c/f9/8a2f075396557ef29f7a28faa342363ba21c879aab11f44add3e00ae910a/aiocronjob-0.7.0.tar.gz",
    "platform": null,
    "description": "# aiocronjob\n\n[![Join the chat at https://gitter.im/aiocronjob/community](https://badges.gitter.im/aiocronjob/community.svg)](https://gitter.im/aiocronjob/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aiocronjob?style=flat-square)\n![PyPI](https://img.shields.io/pypi/v/aiocronjob?style=flat-square)\n![PyPI - License](https://img.shields.io/pypi/l/aiocronjob?style=flat-square)\n![GitHub last commit](https://img.shields.io/github/last-commit/devtud/aiocronjob?style=flat-square)\n![PyPI - Status](https://img.shields.io/pypi/status/aiocronjob?style=flat-square)\n[![Tests](https://github.com/devtud/aiocronjob/actions/workflows/tests.yml/badge.svg)](https://github.com/devtud/aiocronjob/actions/workflows/tests.yml)\n[![Codecov](https://codecov.io/gh/devtud/aiocronjob/branch/main/graph/badge.svg)](https://codecov.io/gh/devtud/aiocronjob)\n\nSchedule and run `asyncio` coroutines and manage them from a web interface or programmatically using the rest api.\n\n### Requires python >= 3.8\n\n### How to install\n\n```bash\npip3 install aiocronjob\n```\n\n### Usage example\n\nSee [examples/simple_tasks.py](https://github.com/devtud/aiocronjob/blob/master/examples/simple_tasks.py)\n\n#### Rest API\n\nOpen [localhost:8000/docs](http://localhost:8000/docs) for endpoints docs.\n\n**`curl`** example:\n \n```bash\n$ curl http://0.0.0.0:8000/api/jobs\n```\n```json\nTBD\n```\n\n### Development\n\n**Requirements**:\n- **Python** >= 3.8 and **PDM** for backend\n\n\n#### Install dependencies\n\n```bash\n$ git clone https://github.com/devtud/aiocronjob.git\n\n$ cd aiocronjob\n\n$ pdm sync\n```\n\n#### Run tests\n\n```bash\npdm run coverage run -m unittest discover\n\npdm run coverage report -m\n```\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Schedule async tasks and manage them using a REST API or WEB UI",
    "version": "0.7.0",
    "split_keywords": [
        "async tasks",
        "crontab",
        "rest api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "2ffbd2d5dbfe92784704b3c18219e10f",
                "sha256": "506ed75ed027e9da46c287423a6025da002d4d28ecb6646195f8ff63db46b653"
            },
            "downloads": -1,
            "filename": "aiocronjob-0.7.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2ffbd2d5dbfe92784704b3c18219e10f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 9245,
            "upload_time": "2022-12-31T16:51:17",
            "upload_time_iso_8601": "2022-12-31T16:51:17.535360Z",
            "url": "https://files.pythonhosted.org/packages/d7/55/39446c8a4cec796cf028755872936c4db893e044dfb97614131c607c85f1/aiocronjob-0.7.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "acdb843150d59ec1269a4647f313ed2e",
                "sha256": "7265679bfd337c38c449f6995113ea2926e416f670b42fbdb35dd28ea8e1cd8a"
            },
            "downloads": -1,
            "filename": "aiocronjob-0.7.0.tar.gz",
            "has_sig": false,
            "md5_digest": "acdb843150d59ec1269a4647f313ed2e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 7534,
            "upload_time": "2022-12-31T16:51:19",
            "upload_time_iso_8601": "2022-12-31T16:51:19.245181Z",
            "url": "https://files.pythonhosted.org/packages/7c/f9/8a2f075396557ef29f7a28faa342363ba21c879aab11f44add3e00ae910a/aiocronjob-0.7.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-31 16:51:19",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "aiocronjob"
}
        
Elapsed time: 0.25192s