# fastapi-apscheduler

**Repository Path**: tinybot/fastapi-apscheduler

## Basic Information

- **Project Name**: fastapi-apscheduler
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 1
- **Created**: 2021-01-09
- **Last Updated**: 2023-11-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 说明


本项目是基于 [FastAPI](http://tiangolo.fastapi.com/) 框架构建的 [APScheduler](https://apscheduler.readthedocs.io/) 定时任务的增删改查 API Demo，**非 FastAPI 插件。**


# 使用

## 依赖安装

使用 [poetry](https://python-poetry.org/) 进行安装与构建：

```shell script
poetry install
```

使用 [pip](https://pypi.org/project/pip/) 进行安装与构建：

```shell script
pip install -r ./requirements.txt
```

## 运行

依赖安装完成后可以直接通过 `uvicorn` 运行整个 API 程序：

```shell script
# 使用 poetry
poetry run uvicorn scheduler:app --host 127.0.0.1 --port 8000

# 使用虚拟环境：切换到 fastapi-apscheduler 项目文件夹下并激活你的虚拟环境
uvicorn scheduler:app --host 127.0.0.1 --port 8000
```

之后可以访问 `127.0.0.1:8000/docs` 或 `127.0.0.1:8000/redoc` 即可看到对应的 API 接口文档。

# LICENSE

MIT