LeetCode Compensation 项目使用教程

LeetCode Compensation 项目使用教程

leetcode-compensation Compensation analysis of leetcode.com/discuss/compensation 项目地址: https://gitcode.com/gh_mirrors/le/leetcode-compensation

1. 项目目录结构及介绍

leetcode-compensation/
├── assets/
│   └── data/
├── leetcomp/
│   ├── env.sample
│   ├── gitignore
│   ├── pre-commit-config.yaml
│   ├── CONTRIBUTING.md
│   ├── LICENSE
│   ├── README.md
│   ├── config.toml
│   ├── index.html
│   ├── pyproject.toml
│   ├── requirements.txt
│   ├── script.js
│   └── style.css
└── README.md

目录结构介绍

• assets/: 存放项目相关的静态资源文件，如数据文件等。
• leetcomp/: 项目的主要代码目录，包含项目的核心逻辑和配置文件。
  • env.sample: 环境变量示例文件。
  • gitignore: Git 忽略文件配置。
  • pre-commit-config.yaml: 预提交钩子配置文件。
  • CONTRIBUTING.md: 贡献指南文件。
  • LICENSE: 项目许可证文件。
  • README.md: 项目说明文件。
  • config.toml: 项目配置文件。
  • index.html: 项目主页文件。
  • pyproject.toml: Python 项目配置文件。
  • requirements.txt: 项目依赖文件。
  • script.js: 项目使用的 JavaScript 脚本文件。
  • style.css: 项目使用的 CSS 样式文件。

2. 项目的启动文件介绍

项目的启动文件主要位于 leetcomp/ 目录下，其中 index.html 是项目的主页文件。启动项目时，通常需要先配置好环境变量和依赖，然后运行相关的 Python 脚本。

启动步骤

1. 安装依赖:

   uv pip install -r requirements.txt
   

2. 配置环境变量: 根据 env.sample 文件中的示例，配置好项目所需的环境变量。

3. 运行项目: 项目的主要启动脚本位于 leetcomp/ 目录下，可以通过以下命令启动：

   python leetcomp/refresh.py && python leetcomp/parse.py
   

3. 项目的配置文件介绍

项目的配置文件主要有两个：config.toml 和 pyproject.toml。

config.toml

config.toml 文件包含了项目的各种配置选项，例如 LLM（语言模型）的配置、数据刷新频率等。以下是一个示例配置：

[llms]
local = "ollama"
api = "openrouter"

pyproject.toml

pyproject.toml 文件是 Python 项目的标准配置文件，包含了项目的元数据、依赖管理等信息。以下是一个示例配置：

[project]
name = "leetcode-compensation"
version = "0.1.0"
description = "Near real-time LeetCode compensation insights for India"
authors = [
    { name="kuutsav", email="kuutsav@example.com" }
]
dependencies = [
    "requests",
    "pandas",
    "numpy"
]

通过以上配置文件，可以灵活地调整项目的运行环境和行为。

leetcode-compensation Compensation analysis of leetcode.com/discuss/compensation 项目地址: https://gitcode.com/gh_mirrors/le/leetcode-compensation