fastapi-apscheduler


Namefastapi-apscheduler JSON
Version 0.0.7 PyPI version JSON
download
home_pagehttps://github.com/grillazz/fastapi-apscheduler
SummaryAllow manage APScheduler with FastAPI router
upload_time2024-08-10 12:23:37
maintainerNone
docs_urlNone
authorJakub Miazek
requires_python<4.0,>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # fastapi-apscheduler


[![Build Status](https://travis-ci.com/viniciuschiele/fastapi-apscheduler.svg?branch=main)](https://travis-ci.com/viniciuschiele/fastapi-apscheduler)
[![PyPI version](https://badge.fury.io/py/fastapi-apscheduler.svg)](https://badge.fury.io/py/fastapi-apscheduler)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Installation

```bash
pip install fastapi-apscheduler
```

## Usage

```python
from fastapi import FastAPI

from fastapi_apscheduler.utils import get_logger
from fastapi_apscheduler.routers import get_jobs_router
from fastapi_apscheduler.scheduler import lifespan

logger = get_logger(__name__)

app = FastAPI(lifespan=lifespan)

app.include_router(get_jobs_router(), prefix="/scheduler", tags=["scheduler"])


async def pytest_job():
    logger.info("test_job")
```



## Build and publish to pypi with poetry
```bash
poetry build

Building fastapi-apscheduler (0.0.x)
  - Building sdist
  - Built fastapi_apscheduler-0.0.x.tar.gz
  - Building wheel
  - Built fastapi_apscheduler-0.0.x-py3-none-any.whl


poetry config pypi-token.pypi <token>


poetry publish

Publishing fastapi-apscheduler (0.0.6) to PyPI
 - Uploading fastapi_apscheduler-0.0.6-py3-none-any.whl 100%
 - Uploading fastapi_apscheduler-0.0.6.tar.gz 100%
```

## Run local instance of worker with uvicorn
```bash
uvicorn example.main:app --workers 1 --port 8084 --log-level debug --env-file example/.env
```

## TODO:
- add CI
- add tests to CI
- add coverage to CI

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/grillazz/fastapi-apscheduler",
    "name": "fastapi-apscheduler",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Jakub Miazek",
    "author_email": "the@grillazz.com",
    "download_url": "https://files.pythonhosted.org/packages/13/ab/7aead78539ee65ca08e09c7df8d82d3a50058ed754b7f570e16d47dd17f9/fastapi_apscheduler-0.0.7.tar.gz",
    "platform": null,
    "description": "# fastapi-apscheduler\n\n\n[![Build Status](https://travis-ci.com/viniciuschiele/fastapi-apscheduler.svg?branch=main)](https://travis-ci.com/viniciuschiele/fastapi-apscheduler)\n[![PyPI version](https://badge.fury.io/py/fastapi-apscheduler.svg)](https://badge.fury.io/py/fastapi-apscheduler)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n## Installation\n\n```bash\npip install fastapi-apscheduler\n```\n\n## Usage\n\n```python\nfrom fastapi import FastAPI\n\nfrom fastapi_apscheduler.utils import get_logger\nfrom fastapi_apscheduler.routers import get_jobs_router\nfrom fastapi_apscheduler.scheduler import lifespan\n\nlogger = get_logger(__name__)\n\napp = FastAPI(lifespan=lifespan)\n\napp.include_router(get_jobs_router(), prefix=\"/scheduler\", tags=[\"scheduler\"])\n\n\nasync def pytest_job():\n    logger.info(\"test_job\")\n```\n\n\n\n## Build and publish to pypi with poetry\n```bash\npoetry build\n\nBuilding fastapi-apscheduler (0.0.x)\n  - Building sdist\n  - Built fastapi_apscheduler-0.0.x.tar.gz\n  - Building wheel\n  - Built fastapi_apscheduler-0.0.x-py3-none-any.whl\n\n\npoetry config pypi-token.pypi <token>\n\n\npoetry publish\n\nPublishing fastapi-apscheduler (0.0.6) to PyPI\n - Uploading fastapi_apscheduler-0.0.6-py3-none-any.whl 100%\n - Uploading fastapi_apscheduler-0.0.6.tar.gz 100%\n```\n\n## Run local instance of worker with uvicorn\n```bash\nuvicorn example.main:app --workers 1 --port 8084 --log-level debug --env-file example/.env\n```\n\n## TODO:\n- add CI\n- add tests to CI\n- add coverage to CI",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Allow manage APScheduler with FastAPI router",
    "version": "0.0.7",
    "project_urls": {
        "Homepage": "https://github.com/grillazz/fastapi-apscheduler",
        "Repository": "https://github.com/grillazz/fastapi-apscheduler"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "05e49561a95354cf05c61210e7a0b60b51a65fff635c6ec2ea24af312c127d8e",
                "md5": "a16c533fc0863b8a3d7dc5419de03a58",
                "sha256": "ee75c8f41e9f1a60b05e8c2a0b8e4f365212c674cd20b1b2feeab526cf65aa86"
            },
            "downloads": -1,
            "filename": "fastapi_apscheduler-0.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a16c533fc0863b8a3d7dc5419de03a58",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 5333,
            "upload_time": "2024-08-10T12:23:36",
            "upload_time_iso_8601": "2024-08-10T12:23:36.187734Z",
            "url": "https://files.pythonhosted.org/packages/05/e4/9561a95354cf05c61210e7a0b60b51a65fff635c6ec2ea24af312c127d8e/fastapi_apscheduler-0.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "13ab7aead78539ee65ca08e09c7df8d82d3a50058ed754b7f570e16d47dd17f9",
                "md5": "2c9bca4013a9e486a791f75efb8be446",
                "sha256": "32d4ee8b3af9803812aba687890a87781f577d6c8de44184a86e5edd2d21b061"
            },
            "downloads": -1,
            "filename": "fastapi_apscheduler-0.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "2c9bca4013a9e486a791f75efb8be446",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 4189,
            "upload_time": "2024-08-10T12:23:37",
            "upload_time_iso_8601": "2024-08-10T12:23:37.534419Z",
            "url": "https://files.pythonhosted.org/packages/13/ab/7aead78539ee65ca08e09c7df8d82d3a50058ed754b7f570e16d47dd17f9/fastapi_apscheduler-0.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-10 12:23:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "grillazz",
    "github_project": "fastapi-apscheduler",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "fastapi-apscheduler"
}
Jakub Miazek
Elapsed time: 0.33319s