My favorites | Sign in
Project Home Source
READ-ONLY: This project has been archived. For more information see this post.
Search
for
Install  
Updated May 9, 2012 by ayanamist

Introduction

Welcome to use TwiOtaku, a GTalk bot using Twitter User Streaming API. The program is written in Python, and can be executed among Windows, Linux, Mac OS, etc.

It is designed as a private service, but not a public service. All users should authenticate via an Invite Code. Non-authenticated users can't use any functions.

Installation

You should install all components in Requirement, either using pip or using setup.py.

Windows user could install MinGW or Visual Studio first because ujson is a pure C extensions.

DotCloud users can SKIP this step for requirements.txt is included and will be applied after push.

You should have your own GTalk account. It's advised to register an seperate account because you may suffer trouble although GTalk allows multiple logins.

You also should have your own Twitter API. You can register one in Twitter Dev

Then you should copy config.sample.py to config.py and fill in everything you got. ADMIN_USERS should contain only your account (not users' accounts).

DON'T MODIFY "DEFAULT TEMPLATE" FIELD UNTIL YOU KNOW HOW TO MODIFY.

DotCloud

DotCloud is a good choice for hosting TwiOtaku. You only need to modify dotcloud.yml and then "dotcloud push". The default config.py is suitable for dotcloud and needed for no more modification. Please refer to documentation of DotCloud for more details.

Linux & Mac

You are strongly recommended to additionally install supervisord as a process manager. I also attach a supervisord.conf to simplify your work, but all other configuration work shoud be done by yourself via Google or anything else.

I suggest you read documentation of supervisord seriously. It will not waste your time if you want TwiOtaku work stably.

Windows

It's not recommended to install TwiOtaku on Windows because there's no suitable process manager. Both NSSM and svrany will kill the process without any signal sending, which may make SQLite database conrrupt.

You can modify as above and execute daemon.py directly.

Post-Installation

After you successfully install the program, you should add the Gtalk bot in your admin Gtalk account, then use "-invite" command to generate invite codes.

Now you can distribute the invite codes. Users can add the Gtalk bot and use "-invite INVITECODE" (replace INVITECODE to real code) command to authenticate.

Powered by Google Project Hosting