Metadata-Version: 2.1
Name: sopel-lichess
Version: 0.2.0
Summary: Lichess plugin for Sopel
Home-page: https://github.com/Exirel/sopel-lichess
Author: Florian Strzelecki
Author-email: florian.strzelecki@gmail.com
License: Eiffel Forum License, version 2
Keywords: sopel plugin lichess chess bot irc
Platform: Linux x86
Platform: x86-64
Classifier: Development Status :: 4 - Beta
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 :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
Requires-Python: <4,>=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: requests
Requires-Dist: sopel (>=7.1)

=============
sopel-lichess
=============

Lichess plugin for Sopel (Lichess URL handler). This plugin handle URL
from https://lichess.org for:

* games
* players
* TV channels

Install
=======

The preferred way to install this plugin is through ``pip``::

    $ pip install sopel-lichess

Note that you may need to use ``pip3``, depending on your system and your
installation.

Once this is done, you should configure and enable the plugin::

    $ sopel-plugins configure lichess
    $ sopel-plugins enable lichess

And then, restart your bot: this, again, depends on your system and how you run
your bot.

Lichess API Key
===============

This plugin uses the lichess.org API and requires an API key to work. Read
the `lichess's authentication documentation`__ to get your key.

.. __: https://lichess.org/api#section/Authentication

The plugin can be configured with the Sopel configuration wizard::

    $ sopel-plugins configure lichess

Or manually, by editing your configuration and adding this section::

    [lichess]
    api_key = <YOUR API KEY>

Replace ``<YOUR API KEY>`` by your API key (no quote needed).


