camplight 0.9.6

安装

安装Camplight及其依赖项的最简单方法：

$ pip install camplight

或者，您可以从源代码安装它：

$ git clone git://github.com/mlafeldt/camplight.git
$ cd camplight/
$ python setup.py install

（请注意，Camplight需要 Requests。）

API使用

fromcamplightimportRequest,Campfirerequest=Request('https://your-subdomain.campfirenow.com','your_token')campfire=Campfire(request)account=campfire.account()rooms=campfire.rooms()room=campfire.room('Danger')room.join()room.speak('ohai')room.leave()

客户使用

Usage: camplight [options] <command> [args]

Options:
  -h, --help            show this help message and exit
  -u URL, --url=URL     set Campfire URL
  -t TOKEN, --token=TOKEN
                        set API token for authentication
  -r ROOM, --room=ROOM  set Campfire room
  -v, --verbose         be more verbose

Global commands:
  account               get account information
  rooms                 list available rooms
  user [id]             get user information
  presence              list rooms the user is present in
  search <term>         search transcripts for term

Room commands (require --room to be set):
  status                get general room information
  recent                list recent messages in the room
  transcript            list all messages sent today to the room
  uploads               list recently uploaded files in the room
  join                  join the room
  leave                 leave the room
  lock                  lock the room
  unlock                unlock the room
  speak <message>       send a regular chat message
  paste <message>       paste a message
  play <sound>          play a sound
  set-name <name>       change the room's name
  set-topic <topic>     change the room's topic

Environment variables:
  CAMPFIRE_URL          same as --url
  CAMPFIRE_TOKEN        same as --token
  CAMPFIRE_ROOM         same as --room
  CAMPFIRE_VERBOSE      same as --verbose

测试

克隆存储库后，使用以下命令运行测试套件：

$ python setup.py test

您可以使用 coverage.py。第一， 安装Coverage软件包：

$ pip install coverage

现在通过运行以下命令收集数据：

$ coverage run setup.py test

并创建报告：

$ coverage report

您还可以创建一个更好的HTML报表：

$ coverage html

现在在浏览器中打开htmlcov/index.html。

许可证

Camplight是根据麻省理工学院的许可条款获得许可的。见 LICENSE 文件。

接触

• 网页：http://mlafeldt.github.com/camplight
• 邮件：mathias.lafeldt@gmail.com
• 推特：@mlafeldt

v0.9.6（2013年8月12日）

• 将可选日期参数添加到Room.transcript()。格式必须为 年/月/日，@luchux提供。

V0.9.5（2013年7月16日）

• 使用 python setup.py doc。我想继续使用降价。

V0.9.4（2013年7月16日）

• 将文档转换为pypi的restructuredtext。
• 建议在自述文件中使用pip install camplight。
• 在manifest.in中每行定义一个文件。

V0.9.3（2013年7月10日）

• 为pypi添加manifest.in。

V0.9.2（2013年7月10日）

• 修复pypi的setup.py。

V0.9.1（2013年2月18日）

• 使用httpretty作为单元测试的模拟库。
• 将Travis生成状态添加到自述文件。
• 更新setup.py中的分类器。

v0.9（2013年2月15日）

修复^ {tt7} $的退出状态。
• 更新许可文件中的版权年。

v0.8（2013年2月8日）

• 如果没有返回文本，请修复json解码。由@astiam报道。
• 特拉维斯：对Python3.3运行测试。

v0.7（2012年12月19日）

• 在单元测试中修复到camplight模块的路径。
• 更新至请求版本1.0.3。

v0.6（2012年11月6日）

• 使用pytest进行单元测试。

v0.5（2012年10月30日）

• 使用添加测试覆盖率 coverage.py。 （@keimlink）
• 在setup.py中正确设置tests_require和extras_require。 （@keimlink）
• 解决由pip installby返回的依赖项错误 在setup.py中硬编码当前的camplight版本。（@jwilder）

v0.4（2012年8月8日）

• 添加单元测试；通过python setup.py test运行它们。
• 添加Travis CI配置。
• python 3兼容性。

v0.3（2012年8月6日）

• 从头重写命令行界面。
• 添加专用营灯例外。
• 使用来自请求v0.12.1的Response.json。
• 添加详细模式。
• 更多的声音。
• 调整每个文件的docstrings。
• 添加setup.py。
• 添加更多文档。

v0.2（2011年10月25日）

• 使用requests作为http 图书馆。
• 将所有http/json处理移动到单独的类。
• 将代码分成camplight包和runner脚本。
• 更多的Python编码风格。修复PEP8错误。
• 添加获取帐户信息的能力（account.json）。
• 更多（未记录的）声音。
• 添加mit许可证文本。

v0.1（2011年5月30日）

• 第一个标记版本。