Metadata-Version: 2.1
Name: sopel
Version: 7.0.0rc1
Summary: Simple and extensible IRC bot
Home-page: https://sopel.chat/
Author: dgw
Author-email: dgw@technobabbl.es
License: Eiffel Forum License, version 2
Description: =======
         Sopel
        =======
        
        |version| |build| |issues| |alerts| |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 <https://pypi.org/project/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
        <https://github.com/sopel-irc/sopel/releases/latest>`_  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
        <https://github.com/sopel-irc/sopel/releases/latest>`_.
        
        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.org/project/backports.ssl_match_hostname>`_.
        
        Note: Python 2.x is near end of life. Sopel will drop support in version 8.0.
        
        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.
        
        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.
        
        Adding modules
        --------------
        The easiest place to put new modules is in ``~/.sopel/modules``. Some newer
        modules are installable as packages; `search PyPI
        <https://pypi.org/search/?q=%22sopel_modules%22>`_ for these. Many more modules
        written by other users can be found using your favorite search engine.
        
        Some older, unmaintained modules are available in the
        `sopel-extras <https://github.com/sopel-irc/sopel-extras>`_ repository, but of
        course you can also write your own. A `tutorial <https://sopel.chat/tutorials/part-2-writing-modules/>`_
        for creating new modules 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 html`` in the ``docs``
        directory.
        
        Further documentation
        ---------------------
        
        The `official website <https://sopel.chat/>`_ includes such valuable information
        as a full listing of built-in `commands <https://sopel.chat/usage/commands/>`_,
        `tutorials <https://sopel.chat/tutorials/>`_, `API documentation <https://sopel.chat/docs/>`_,
        and other `usage information <https://sopel.chat/usage/>`_.
        
        Questions?
        ----------
        
        Join us in `#sopel <irc://irc.freenode.net/#sopel>`_ on Freenode.
        
        Credits
        -------
        
        Contributors
        ============
        
        This project exists thanks to all the people who contribute! `Become a contributor`__.
        
        .. image:: https://opencollective.com/sopel/contributors.svg?width=890&button=false
            :target: https://github.com/sopel-irc/sopel/graphs/contributors
        
        __ Contributor_
        .. _Contributor: https://github.com/sopel-irc/sopel/blob/master/CONTRIBUTING.md
        
        Backers
        =======
        
        Thank you to all our backers! `Become a backer`__.
        
        .. image:: https://opencollective.com/sopel/backers.svg?width=890
            :target: https://opencollective.com/sopel#backers
        
        __ Backer_
        .. _Backer: https://opencollective.com/sopel#backer
        
        Sponsors
        ========
        
        Support Sopel by becoming a sponsor. Your logo will show up here with a link to your website. `Become a sponsor`__.
        
        .. image:: https://opencollective.com/sopel/sponsor/0/avatar.svg
            :target: https://opencollective.com/sopel/sponsor/0/website
        
        __ Sponsor_
        .. _Sponsor: https://opencollective.com/sopel#sponsor
        
        .. |version| image:: https://img.shields.io/pypi/v/sopel.svg
           :target: https://pypi.python.org/pypi/sopel
        .. |build| image:: https://travis-ci.org/sopel-irc/sopel.svg?branch=master
           :target: https://travis-ci.org/sopel-irc/sopel
        .. |issues| image:: https://img.shields.io/github/issues/sopel-irc/sopel.svg
           :target: https://github.com/sopel-irc/sopel/issues
        .. |alerts| image:: https://img.shields.io/lgtm/alerts/g/sopel-irc/sopel.svg
           :target: https://lgtm.com/projects/g/sopel-irc/sopel/alerts/
        .. |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
        
Platform: Linux x86
Platform: x86-64
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: Eiffel Forum License (EFL)
Classifier: License :: OSI Approved :: Eiffel Forum License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,<4,>=2.7
Description-Content-Type: text/x-rst
Provides-Extra: dev
