Pusher HTTP Python 开源项目教程

Pusher HTTP Python 开源项目教程

pusher-http-pythonPusher Channels HTTP API library for Python项目地址:https://gitcode.com/gh_mirrors/pu/pusher-http-python

1. 项目的目录结构及介绍

pusher-http-python/
├── LICENSE
├── README.md
├── pusher
│   ├── __init__.py
│   ├── __main__.py
│   ├── asyncio.py
│   ├── aiohttp.py
│   ├── client.py
│   ├── exceptions.py
│   ├── http.py
│   ├── __pycache__
│   └── util.py
├── requirements.txt
├── setup.cfg
├── setup.py
└── tests
    ├── __init__.py
    ├── __pycache__
    ├── test_aiohttp.py
    ├── test_client.py
    ├── test_exceptions.py
    ├── test_http.py
    └── test_util.py

目录结构介绍

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• pusher/: 核心代码目录。
  • __init__.py: 模块初始化文件。
  • __main__.py: 主程序入口文件。
  • asyncio.py: 异步I/O支持文件。
  • aiohttp.py: 异步HTTP客户端支持文件。
  • client.py: 客户端实现文件。
  • exceptions.py: 异常处理文件。
  • http.py: HTTP请求处理文件。
  • util.py: 工具函数文件。
• requirements.txt: 项目依赖文件。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本文件。
• tests/: 测试代码目录。
  • test_*.py: 各个模块的测试文件。

2. 项目的启动文件介绍

项目的启动文件是 pusher/__main__.py。该文件通常包含项目的入口点，可以通过命令行直接运行项目。

# pusher/__main__.py
from pusher import Pusher

def main():
    pusher = Pusher(app_id='your_app_id', key='your_key', secret='your_secret')
    pusher.trigger('my-channel', 'my-event', {'message': 'hello world'})

if __name__ == '__main__':
    main()

3. 项目的配置文件介绍

项目的配置文件主要是 setup.cfg 和 setup.py。

setup.cfg

setup.cfg 文件包含了项目的元数据和安装配置。

[metadata]
name = pusher-http-python
version = 2.0.1
description = Python library to interact with the Pusher HTTP API
long_description = file: README.md
long_description_content_type = text/markdown
author = Pusher
author_email = support@pusher.com
url = https://github.com/pusher/pusher-http-python
license = MIT
classifiers =
    Development Status :: 5 - Production/Stable
    Intended Audience :: Developers
    License :: OSI Approved :: MIT License
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.6
    Programming Language :: Python :: 3.7
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9

[options]
packages = find:
install_requires =
    aiohttp
    requests

[options.packages.find]
where = .

setup.py

setup.py 文件是用于安装项目的脚本。

from setuptools import setup, find_packages

setup(
    name='pusher-http-python',
    version='2.0.1',
    description='Python library to interact with the Pusher HTTP API',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    author='Pusher',
    author_email='support@pusher.com',
    url='https://github.com/pusher/pusher-http-python',
    license='MIT',
    packages=find_packages(),
    install_requires=[
        'aiohttp',
        'requests',
    ],
    classifiers=[
        'Development Status :: 5 - Production/Stable',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
    ],
)

这两个文件共同定义了项目的安装和配置信息，确保项目能够正确地安装和运行。

pusher-http-pythonPusher Channels HTTP API library for Python项目地址:https://gitcode.com/gh_mirrors/pu/pusher-http-python