Camplight is a Python implementation of the Campfire API.
The project comes with a Python module that can be imported via
and a simple command-line tool named
camplight to utilize it.
The easiest way to install Camplight and its dependencies:
$ pip install camplight
Alternatively, you can install it from source:
$ git clone git://github.com/mlafeldt/camplight.git $ cd camplight/ $ python setup.py install
(Note that Camplight requires Requests.)
from camplight import Request, Campfire request = 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 [date] list all messages sent to the room (on date YYYY/MM/DD) 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
After cloning the repository, run the test suite using:
$ python setup.py test
You can generate a coverage report using coverage.py. First, install the coverage package:
$ pip install coverage
Now gather the data by running:
$ coverage run setup.py test
And create a report:
$ coverage report
You can also create a much nicer HTML report:
$ coverage html
htmlcov/index.html in your browser.
Camplight is licensed under the terms of the MIT License. See LICENSE file.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request