Dozingfiretruck / HibiAPI

An alternative implement of Imjad API | Imjad API 的开源替代

Home Page:https://api.obfs.dev/docs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

HibiAPI

Demo Version

Code Linting Testing

Version GitHub last commit GitHub license GitHub stars GitHub forks GitHub issues Python version

An alternative implement of Imjad API.

Imjad API 的开源替代.


前言

由于Imjad API使用人数过多致使调用超出限制, 所以本人希望提供一个开源替代来供社区进行自由的部署和使用, 从而减轻一部分该API的使用压力

实现进度

请点击此处查看

部署指南

准备环境

部署本项目, 你需要:

  • Python 3.8 及以上

  • 一个通畅的网络

    • 为了使用Pixiv等API功能, 您可能需要设置一个HTTP代理
    • 如果依赖安装过慢, 请更换一个在您地区速度较快的pip镜像

安装依赖

使用传统 pip

requirements.txt 生成状态: Generate Requirements

  1. 保存本仓库到本地目录, 命令行进入该目录

  2. (推荐) 使用 virtualenv 等工具设置虚拟环境

  3. 安装依赖

    • 通常来讲,你只需要执行 pip install -r requirements.txt
    • 如果你遇到一些权限问题或者安装后无法使用, 请自行解决

使用 poetry (推荐)

  1. 保存本仓库到本地目录, 命令行进入该目录

  2. 安装poetry

    • 通常来讲,你只需要执行 pip install poetry
    • 如果你遇到一些权限问题或者安装后无法使用, 请自行解决
  3. 激活虚拟环境

poetry install #安装本项目依赖 (可能需要较长时间)
poetry shell #进入激活了虚拟环境的shell

运行程序

  1. 首次运行生成配置文件

    • python main.py 直接运行, 如果有未生成的配置文件会报错退出
    • 进入config目录修改对应的配置文件
    • 注意!后缀为.default.yml的配置文件为默认配置文件,不建议修改
  2. 运行程序

    • 在虚拟环境中直接输入 python main.py 即可

鸣谢

About

An alternative implement of Imjad API | Imjad API 的开源替代

https://api.obfs.dev/docs

License:Apache License 2.0


Languages

Language:Python 100.0%