Skip to content

Commit

Permalink
new release
Browse files Browse the repository at this point in the history
  • Loading branch information
benhoff committed May 21, 2016
1 parent da5735a commit f883565
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 88 deletions.
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,13 @@
[![Build Status](https://travis-ci.org/benhoff/CHATIMUSMAXIMUS.svg?branch=master)](https://travis-ci.org/benhoff/CHATIMUSMAXIMUS) [![Code Climate](https://codeclimate.com/github/benhoff/CHATIMUSMAXIMUS/badges/gpa.svg)](https://codeclimate.com/github/benhoff/CHATIMUSMAXIMUS)

A Python3.5, PyQt chat GUI featuring support for the following websites
> Youtube (Selenium based scraper)
> Youtube (Selenium based scraper or Youtube API)
> Twitch (IRC client)
> WatchPeopleCode (websocket client)
> Livecoding (xmpp client)
### Installation instructions
1. Install PyQt5 onto your system
2. Install PhantomJS onto your system
3. `pip install chatimusmaximus[gui,javascript_webscrapper,irc,socket_io,xmpp,youtube]`
1. `pip install chatimusmaximus`
4. create a settings.yml file using `default_settings.yml` as guidance
5. `chatimusmaximus --settings_path /path/to/your/settings.yml`

Expand All @@ -19,21 +17,10 @@ A Python3.5, PyQt chat GUI featuring support for the following websites
2. `python setup.py develop`
3. `python chatimusmaximus`

### Socket Address?
Chatimusmaximus uses messaging and subprocesses for different services. This has some advantages/disadvantages of this approach, but the reason it's staying is it allows the developer some decreased congnitive load while developing this project.

The socket address expected is in the format of `tcp://[ADDRESS]:[PORT_NUMBER]`.
For example `tcp://127.0.0.1:5617` is a valid socket address. 127.0.0.1 is the ADDRESS and 5617 is the PORT_NUMBER.

#### TCP address
127.0.0.1 was chosen specifially as an example because for IPV4 it is the "localhost". Localhost is the computer the program is being run on. So if you want the program to connect to a socket on your local computer (you probably do), use 127.0.0.1.

#### Ports
Port numbers range from 0-65536, and can be mostly aribratry chosen. For linux ports 0-1024 are reserved, so best to stay away from those. Port 5555 is usually used as an example port for coding examples, so probably best to stay away from that as well.

If you run into issues, send me an email [beohoff@gmail] or start an issue!

### Running instructions
1. change into the `chatimusmaximus` source directory and from the command line run `python chatimusmaximus`
2. Or run the code from vexbot `https://github.com/benhoff/vexbot.git`. I haven't had time to write up running instructions for vexbot :shame: but feel free to email me about it.

pull requests welcome!
52 changes: 2 additions & 50 deletions chatimusmaximus/default_settings.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: "0.1.3"
version: "0.1.4"

display:
command_line: "user@chatimus ~$ "
Expand All @@ -15,64 +15,16 @@ sockets_to_connect_to:
services:

irc:

twitch:
# I use this site to get oauth_token
# https://twitchapps.com/tmi/
# use this format: `oauth:asdasd234asd234ad234asds23`
password: ""
# this will be your twitch channel
# should be something like "#beohoff"
channel: ""
# I believe this has to be your twitch acct name
nick: ""
host: 'irc.twitch.tv'
socket_address: ""
connect: false
display_missing: true

xmpp:

livecoding:
# this MUST be your livecode name
# This is a name
local: ""
# this can be your profile password
password: ""
bot_nick: ""
# room is going to look something like `benhoff@chat.livecoding.tv`
room: ""
domain: 'livecoding.tv'
resource: 'CHATIMUSMAXIMUS'
socket_address: ""
connect: false
display_missing: true

# socket_io is hardcoded for watchpeople code
# feel free to yell at me about that on github
socket_io:

watchpeoplecode:
streamer_name: ""
namespace: '/chat'
website_url: 'http://www.watchpeoplecode.com/socket.io/1/'
socket_address: ""
connect: false
display_missing: true

# youtube is special.

youtube:
socket_address: ""
connect: false
display_missing: true

# must install selenium. Don't need OAuth credentials
javascript_scraper:
youtube_url: ""

# go to goole developers console. Create an app and request
# YouTube Data API v3 access. Create and download OAuth credentials
# and put the filepath info in `client_secrets_file`
api_connect:
# use an absolute filepath!
client_secrets_file: ""
26 changes: 5 additions & 21 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,23 +1,7 @@
aiodns==1.0.1
docopt==0.6.2
google-api-python-client==1.5.0
httplib2==0.9.2
irc3==0.8.8
oauth2client==2.0.0.post1
pluginmanager
pyasn1==0.1.9
pyasn1-modules==0.0.8
pycares==1.0.0
pluginmanager==0.4.0
PyQt5==5.6
PyYAML==3.11
pyzmq==15.2.0
Quamash==0.5.4
requests==2.9.1
rsa==3.3
selenium==2.52.0
simplejson==3.8.2
six==1.10.0
slixmpp
uritemplate==0.6
venusian==1.0
websocket-client==0.35.0
wheel==0.26.0
Quamash==0.5.5
sip==4.18
vexbot
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@
package_data={'chatimusmaximus': ['default_settings.yml', 'gui/resources/click.wav', 'gui/resources/icons/*', 'gui/resources/buttons/*']},

install_requires=[
'pluginmanager',
'pyzmq',
'PyYAML',
'pYqT5',
'Quamash',
'vexbot',
],
Expand Down

0 comments on commit f883565

Please sign in to comment.