PYGA: Python Google Analytics (ga.js) - Data Collection API 使用教程
1. 项目的目录结构及介绍
py-ga-mob/
├── doc/
│ └── ...
├── pygapyga/
│ ├── __init__.py
│ ├── ...
├── tests/
│ └── ...
├── .coveragerc
├── .gitignore
├── .pyup.yml
├── CODE_OF_CONDUCT.md
├── LICENSE
├── MANIFEST.in
├── README.rst
├── RELEASES
├── requirements.txt
└── setup.py
目录结构介绍
- doc/: 存放项目的文档文件。
- pygapyga/: 项目的主要代码文件夹,包含实现Google Analytics数据收集的核心代码。
- tests/: 存放项目的测试代码。
- .coveragerc: 配置代码覆盖率测试的文件。
- .gitignore: Git忽略文件配置。
- .pyup.yml: 配置依赖更新检查的文件。
- CODE_OF_CONDUCT.md: 项目的行为准则。
- LICENSE: 项目的开源许可证。
- MANIFEST.in: 配置Python包的文件列表。
- README.rst: 项目的介绍和使用说明。
- RELEASES: 项目的发布历史记录。
- requirements.txt: 项目的依赖库列表。
- setup.py: 项目的安装配置文件。
2. 项目的启动文件介绍
项目的启动文件是 setup.py
,它负责项目的安装和配置。通过运行 python setup.py install
,可以将项目安装到本地环境中。
setup.py
文件介绍
from setuptools import setup, find_packages
setup(
name='pyga',
version='0.1',
packages=find_packages(),
install_requires=[
# 依赖库列表
],
entry_points={
'console_scripts': [
# 命令行工具入口
],
},
)
- name: 项目的名称。
- version: 项目的版本号。
- packages: 需要包含的Python包。
- install_requires: 项目依赖的Python库。
- entry_points: 定义命令行工具的入口。
3. 项目的配置文件介绍
项目的配置文件主要包括 .coveragerc
和 .pyup.yml
。
.coveragerc
文件介绍
[run]
source = pygapyga
omit =
pygapyga/tests/*
pygapyga/__init__.py
- source: 指定需要进行代码覆盖率测试的源代码目录。
- omit: 指定需要忽略的文件或目录。
.pyup.yml
文件介绍
# PyUp配置文件
requirements:
- requirements.txt
- requirements: 指定需要检查更新的依赖库文件。
通过这些配置文件,可以确保项目的依赖库保持最新,并且代码覆盖率测试能够正确运行。