Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sopel-irc/sopel

:robot::speech_balloon: An easy-to-use and highly extensible IRC Bot framework. Formerly Willie.
https://github.com/sopel-irc/sopel

hacktoberfest irc irc-bot irc-bot-framework python

Last synced: 6 days ago
JSON representation

:robot::speech_balloon: An easy-to-use and highly extensible IRC Bot framework. Formerly Willie.

Awesome Lists containing this project

README 

        
=======

 Sopel

=======



|version| |build| |issues| |coverage-status| |license|



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

=====================

On most systems where you can run Python, the best way to install Sopel is to

install `pip `_ and then ``pip install sopel``.



Arch users can install the ``sopel`` package from the [community] repository,

though new versions might take slightly longer to become available.



Failing both of those options, you can grab the latest tarball `from GitHub

`_  and follow the steps

for installing from the latest source below.



Latest source

=============

First, either clone the repository with ``git clone

https://github.com/sopel-irc/sopel.git`` or download a `source archive from

GitHub `_.



Note: Sopel requires Python 3.8+ to run.



In the source directory (whether cloned or from the tarball) run ``pip install

-e .``. You can then run ``sopel`` to configure and start the bot.



Database support

----------------

Sopel leverages SQLAlchemy to support the following database types: SQLite,

MySQL, PostgreSQL, MSSQL, Oracle, Firebird, and Sybase. By default Sopel will

use a SQLite database in the current configuration directory, but alternative

databases can be configured with the following config options: ``db_type``,

``db_filename`` (SQLite only), ``db_driver``, ``db_user``, ``db_pass``,

``db_host``, ``db_port``, and ``db_name``. You will need to manually install

any packages (system or ``pip``) needed to make your chosen database work.



**Note:** Plugins not updated since Sopel 7.0 was released *might* have

problems with database types other than SQLite (but many will work just fine).



Adding plugins

--------------

The easiest place to put new plugins is in ``~/.sopel/plugins``. Some newer

plugins are installable as packages; `search PyPI

`_ for these. Many more plugins

written by other users can be found using your favorite search engine.



Some older, unmaintained plugins are available in the

`sopel-extras `_ repository, but of

course you can also write your own. A `tutorial `_

for creating new plugins is available on Sopel's website.

API documentation can be found online at https://sopel.chat/docs/, or

you can create a local version by running ``make docs``.



Further documentation

---------------------



The `official website `_ includes such valuable information

as a full listing of built-in `commands `_,

`tutorials `_, `API documentation `_,

and other `usage information `_.



Questions?

----------



Join us in `#sopel `_ on Libera Chat.



Donations

---------



We're thrilled that you want to support the project!



You can `sponsor Sopel `_ here on

GitHub or donate through `Open Collective `_.



Any donations received will be used to cover infrastructure costs, such as our

domain name and hosting services. Our main project site is easily hosted by

`Netlify `_, but we are considering building a few

new features that would require more than static hosting. All project-related

`expenses `_ are tracked on our

Open Collective profile, for transparency.



.. |version| image:: https://img.shields.io/pypi/v/sopel.svg

   :target: https://pypi.python.org/pypi/sopel

.. |build| image:: https://github.com/sopel-irc/sopel/actions/workflows/ci.yml/badge.svg?branch=master&event=push

   :target: https://github.com/sopel-irc/sopel/actions/workflows/ci.yml?query=branch%3Amaster+event%3Apush

.. |issues| image:: https://img.shields.io/github/issues/sopel-irc/sopel.svg

   :target: https://github.com/sopel-irc/sopel/issues

.. |coverage-status| image:: https://coveralls.io/repos/github/sopel-irc/sopel/badge.svg?branch=master

   :target: https://coveralls.io/github/sopel-irc/sopel?branch=master

.. |license| image:: https://img.shields.io/pypi/l/sopel.svg

   :target: https://github.com/sopel-irc/sopel/blob/master/COPYING