semvec/pypi-packages huggingface dataset:
torra 1.0.41
Torrent client
License: MIT
Requires Python: >=3

Torrent client.\
To remove configuration launch ```torra --remove-config```. There is also ```torra --debug```.\
To specify another torrent list at start, launch with an argument, e.g. ```torra ~/torrents.txt```, or ```torra f ~/torrents.txt```\
[Git Page](https://github.com/colin-i/tora)
algoflow 0.1.0
A FastAPI-based algorithm flow management system with Tortoise ORM and Aerich for database migrations
License: MIT
Requires Python: >=3.12.9
Keywords: aerich, algorithm, fastapi, tortoise-orm, workflow

# FastAPI 模板

一个用于构建 FastAPI 应用程序的模板项目，包含 Tortoise ORM 和 Aerich 用于数据库迁移。

## 特性

- FastAPI、Tortoise ORM、Aerich 和 Pydantic 构建
- Docker Compose 快速部署
- Github Actions CI/CD

## 使用

### 安装

1. **克隆仓库：**

    ```bash
    git clone https://github.com/chenxingyuu/fastapi_template.git
    cd fastapi-template
    ```

2. **创建并激活虚拟环境：**

    ```bash
    python -m venv venv
    source venv/bin/activate  # 在 Windows 上使用 `venv\Scripts\activate`
    ```

3. **安装依赖项：**

    ```bash
    pip install -r requirements.txt
    ```

### 迁移

1. **初始化 Aerich：**

    ```bash
    make init
    ```

2. **初始化数据库：**

    ```bash
    make init-db
    ```

3. **创建并应用迁移：**

    ```bash
    make migrate
    make upgrade
    ```
4. **回滚迁移：**

    ```bash
    make downgrade
    ```

### 运行

1. **设置配置文件路径：**

   在 Linux 或 macOS 上：
    ```bash
    export CONFIG_FILE_PATH=/path/to/your/config.ini
    ```

   在 Windows 上：
    ```cmd
    set CONFIG_FILE_PATH=C:\path\to\your\config.ini
    ```

2. **启动 FastAPI 应用程序：**

    ```bash
    uvicorn app.main:app --reload
    ```

3. **访问应用程序：**

   打开浏览器并访问 `http://127.0.0.1:8000`。

### 使用 Docker

1. **构建 Docker 镜像：**

    ```bash
    docker build -t algo-flow:0.1.0 .
    ```

2. **运行 Docker 容器：**

    ```bash
    docker run -d -p 8000:8000 --name algo-flow-api algo-flow:0.1.0
    ```

3. **访问应用程序：**

   打开浏览器并访问 `http://127.0.0.1:8000`。

### 使用 Docker Compose

1. **启动服务：**

    ```bash
    docker-compose up -d
    ```

2. **访问应用程序：**

   打开浏览器并访问 `http://127.0.0.1:8000`。

3. **停止服务：**

    ```bash
    docker-compose down
    ```

## 开发

1. **安装 pre-commit 钩子：**

    ```bash
    pre-commit install
    ```

2. **运行测试：**

    ```bash
   # 运行所有测试
    pytest -v
   # 如果你想生成覆盖率报告，可以使用以下命令：
    pytest --cov-report=html -v
    ```

3. **检查代码并格式化：**

    ```bash
    pre-commit run --all-file
    ```

4. **在开发模式下运行应用程序：**

    ```bash
    uvicorn app.main:app --reload
    ```

## 配置

配置通过 `config.ini` 文件进行管理。在运行应用程序之前，请确保将 `CONFIG_FILE_PATH` 环境变量设置为指向你的配置文件。