Giter VIP home page Giter VIP logo

sopel's Introduction

version downloads license issues forks stars ages works badges

Introduction

Sopel is a simple, lightweight, open source, easy-to-use IRC Utility bot, written in Python. It's designed to be easy to use, run and extend.

Installation

Latest stable release

If you're on Arch, the easiest way to install is through your package manager. The package is named sopel in [community] repository. On other distros, and pretty much any operating system you can run Python on, you can install pip, and do pip install sopel. Failing all that, you can download the latest tarball from http://sopel.chat and follow the steps for installing from the latest source below.

Latest source

First, either clone the repository with git clone git://github.com/sopel-irc/sopel.git or download a tarball from GitHub.

Note: sopel requires Python 2.7.x or Python 3.3+ to run. On Python 2.7, sopel requires backports.ssl_match_hostname to be installed. Use pip install backports.ssl_match_hostname or yum install python-backports.ssl_match_hostname to install it, or download and install it manually from PyPi <https://pypi.python.org/pypi/backports.ssl_match_hostname>.

In the source directory (whether cloned or from the tarball) run setup.py install. You can then run sopel to configure and start the bot. Alternately, you can just run the sopel.py file in the source directory.

Adding modules

The easiest place to put new modules is in ~/.sopel/modules.

Some extra modules are available in the sopel-extras repository, but of course you can also write new modules. A tutorial for creating new modules is available on the wiki. API documentation can be found online at http://sopel.chat/docs, or you can create a local version by running make html in the doc directory.

Further documentation

In addition to the official website, there is also a wiki which includes valuable information including a full listing of commands.

Questions?

Join us in #sopel on Freenode.

sopel's People

Contributors

anarcat avatar bui avatar depierre avatar dgw avatar eldonmcguinness avatar embolalia avatar erethon avatar flashcactus avatar jfriedly avatar johnlage avatar kays avatar kitschysynq avatar lramati avatar matiasv avatar maxpowa avatar meinwald avatar mjscribble avatar myano avatar nache avatar ohcanep avatar pmrowla avatar preston4tw avatar saltire avatar silasb avatar singingwolfboy avatar stopspazzing avatar tyrope avatar venti- avatar warddr avatar yoosi avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.