DONT USE THIS I NEVER FINISHED AND DON'T USE PYTHON ANY MORE Python 3 library and CLI for Stack Exchange chat (unofficial)
Clone or download
Pull request Compare This branch is 133 commits ahead, 14 commits behind Manishearth:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
stackchat
.gitignore
.gitlab-ci.yml
CNAME
LICENSE-APACHE
LICENSE-MIT
Pipfile
Pipfile.lock
Procfile
README.md
publish.cmd
setup.py
stack.chat
test

README.md

stack.chat

stack.chat is an unofficial Python 3 library and command-line tool for Stack Exchange chat.

Links

Installation

Using your Python 3 package manager of choice:

pip3 install stack.chat

For Contributors

Contributors who clone this repo can install our dev packages with pipenv:

pip install pipenv
pipenv install --dev

Basic Usage

CLI

The default config uses a temporary in-memory database and requires your Stack Exchange credentials to be provided through environment variables. We can see this by checking the current config with stack.chat config.

$ stack.chat config
# the default config should appear

Instead, we'll want to use stack.chat init --global to remember our credentials and create a persistent local database.

$ stack.chat init --global
# TODO: what happens here?
# seeding database...

$ stack.chat config
#

We can confirm it worked with TODO:

$ stack.chat whoami --server=se

You can read the latest messages in a chat room with stack.chat tail.

$ stack.chat tail --server=se --room=1
# TODO

Certain common parameters, such as --server and --room, will be saved and used as the default if you omit that parameter the next time it's required for a command. TODO

$ stack.chat tail --since-last --follow
#
^C

Let's TODO!

$ stack.chat send "hello, world"
#

More details are available from the application itself.

$ stack.chat help

Python

The Python interface is not yet stable.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache License, Version 2.0, shall be dual licensed as above, without any additional terms or conditions.

Contributors

Please see the Git commit history or this list on GitHub.