Switchio 项目教程

Switchio 项目教程

switchio asyncio powered FreeSWITCH cluster control 项目地址: https://gitcode.com/gh_mirrors/sw/switchio

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

Switchio 项目的目录结构如下：

switchio/
├── docs/
├── freeswitch-sounds/
├── switchio/
├── tests/
├── .gitignore
├── .travis.yml
├── CHANGELOG.rst
├── LICENSE
├── README.rst
├── requirements-doc.txt
├── requirements-test.txt
├── setup.cfg
├── setup.py
└── tox.ini

目录介绍：

• docs/: 存放项目的文档文件。
• freeswitch-sounds/: 存放 FreeSWITCH 的声音文件。
• switchio/: 项目的主要代码目录，包含核心功能实现。
• tests/: 存放项目的测试代码。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.rst: 项目更新日志。
• LICENSE: 项目许可证文件。
• README.rst: 项目介绍和使用说明。
• requirements-doc.txt: 文档生成所需的依赖包。
• requirements-test.txt: 测试所需的依赖包。
• setup.cfg: 项目配置文件。
• setup.py: 项目安装脚本。
• tox.ini: Tox 配置文件，用于自动化测试。

2. 项目的启动文件介绍

Switchio 项目的启动文件主要位于 switchio/ 目录下。以下是主要的启动文件：

• switchio/apps/routers.py: 路由配置文件，定义了如何处理不同的呼叫请求。
• switchio/service.py: 服务启动文件，用于启动 Switchio 服务。

启动步骤：

1. 从命令行启动:

   $ switchio serve fs-host1 fs-host2 fs-host3 --app /path/to/dialplan.py:router
   

2. 从脚本启动:

   if __name__ == '__main__':
       from switchio import Service
       service = Service(['fs-host1', 'fs-host2', 'fs-host3'])
       service.apps.load_app(router, app_id='default')
       service.run()
   

3. 项目的配置文件介绍

Switchio 项目的配置文件主要位于项目根目录下。以下是主要的配置文件：

• setup.cfg: 项目配置文件，包含安装和构建的配置信息。
• tox.ini: Tox 配置文件，用于自动化测试。
• .travis.yml: Travis CI 配置文件，用于持续集成。

配置文件示例：

setup.cfg:

[metadata]
name = switchio
version = 0.1.alpha
description = asyncio powered FreeSWITCH cluster control
long_description = file: README.rst
author = Friends of FreeSWITCH
author_email = friends@freeswitch.org
license = MPL-2.0
url = https://github.com/friends-of-freeswitch/switchio

tox.ini:

[tox]
envlist = py36,py37,py38
skipsdist = true

[testenv]
deps =
    -rrequirements-test.txt
commands =
    pytest tests/

.travis.yml:

language: python
python:
  - "3.6"
  - "3.7"
  - "3.8"
install:
  - pip install -r requirements-test.txt
script:
  - pytest tests/

通过以上配置文件，可以实现项目的自动化测试和持续集成。

switchio asyncio powered FreeSWITCH cluster control 项目地址: https://gitcode.com/gh_mirrors/sw/switchio