yyxx game custom module
Project description
YYXXGAME-PKG
yyxx-game-pkg
是一个专门为元游公司后台开发的 Python 内部接口集合。
元游信息
目录
上手指南
环境配置
1.环境安装python3.11以上版本
安装步骤
1.Clone代码
git clone https://github.com/yyxxgame/yyxxgame-pkg.git
2.安装poetry
- curl -sSL https://install.python-poetry.org | python3
- export PATH="/root/.local/bin:$PATH"
3.配置虚拟环境并激活
- poetry env use python3
- poetry env list
- poetry shell
4.添加包
关于poetry
的使用,参考文档:http://yydocs.yyxxgame.com/web/#/183/1758
- poetry add numpy # 基本使用
- poetry add numpy --optional # 添加额外包(针对项目单独使用的包)
如果使用
--optional
,需要手动修改pyproject.toml
文件
- 1.在
[tool.poetry.extras]
增加相应extra
分组和包- 2.命令行
poetry lock
更新poetry.lock
文件- 3.命令行
poetry install -E center_api
安装optional
中的包
# example
[tool.poetry.extras]
center_api = ["flask", "numpy"]
stat = ["pandas", "numpy"]
5.安装依赖
# 开发 yyxxgame-pkg 安装依赖
# 安装基础依赖,以及额外center_api依赖
- poetry install -E stat
- poetry install -E stat -E center_api # 安装多个额外依赖
- poetry install --extras "stat center_api"
# 项目中使用 yyxxgame-pkg 安装依赖
- poetry add yyxx-game-pkg[stat]
- pip install yyxx-game-pkg[stat]
文件目录说明
yyxxgame-pkg
├── README.md
├── gen_version.py
├── images
│ └── logo.png
├── poetry.lock
├── pyproject.toml
├── tests
│ ├── __init__.py
│ ├── dispatch
│ ├── submit
│ ├── test_ip2region.py
│ ├── test_logger.py
│ ├── test_xtrace.py
│ ├── utils
│ └── xcelery
└── yyxx_game_pkg
├── __init__.py
├── helpers
├── ip2region
├── logger
├── stat
├── utils
└── xtrace
部署
develop
提交注释中添加[BUILD]
关键字并推送会触发github actions的dev版本构建并发布到yyxx-game-pkg-dev
release
新建tag
并推送会触发github actions的正式版本构建并发布到yyxx-game-pkg
模块介绍
yyxxgame-pkg包含以下模块:
xtrace
xtrace
模块封装了链路追踪的帮助类,可以帮助开发人员快速地实现链路追踪功能。
stat
stat
模块包含yyxxgame内部统计业务的底层框架,目前包含dispatch
、submit
、xcelery几个模块
代码示例
参考test 中的调用例子
版本控制
该项目使用Git进行版本管理。您可以在repository参看当前可用版本。
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for yyxx_game_pkg_dev-2023.7.12.1.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1415f5c6600ed1d4ec28d6fc71f27d3863627178dc2e0bd0cc65a4541359473 |
|
MD5 | 33990f5c0ac7ed1f684d7b54646c6f36 |
|
BLAKE2b-256 | 573dfaf7d8fd0b2d4108b66bc44af7ef45e949165471760859111d2a800bc93f |
Close
Hashes for yyxx_game_pkg_dev-2023.7.12.1.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | abc5ed0428ff879d81b5f95b0291f4c4256c0071d416b255f9b0adb0fb211598 |
|
MD5 | f65ef09d1e19bf71541b58d55d3a4cbc |
|
BLAKE2b-256 | dbec40ec6c293837bd9ac804b1eaa0ed300aba0c53f74c23dc31171a97ff494c |