Metadata-Version: 2.1
Name: gitscribe
Version: 0.1.0
Summary: A Discord bot that provides information about GitHub repositories and issues.
Home-page: https://github.com/oss-reva/gbot.py
Author: SNG Viraj Reddy
Author-email: vir200319@gmail.com
License: MIT
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
License-File: LICENSE
Requires-Dist: aiohttp ==3.8.5
Requires-Dist: aiosignal ==1.3.1
Requires-Dist: async-timeout ==4.0.3
Requires-Dist: attrs ==23.1.0
Requires-Dist: certifi ==2023.7.22
Requires-Dist: charset-normalizer ==3.2.0
Requires-Dist: discord.py ==2.3.2
Requires-Dist: frozenlist ==1.4.0
Requires-Dist: idna ==3.4
Requires-Dist: multidict ==6.0.4
Requires-Dist: python-dotenv ==1.0.0
Requires-Dist: requests ==2.31.0
Requires-Dist: urllib3 ==2.0.5
Requires-Dist: yarl ==1.9.2

============================
gbot.py
============================

gbot.py is a Python Discord bot that provides information about GitHub repositories and issues. It's designed to make it easier for users to retrieve details about GitHub projects directly within a Discord server.

Installation
------------

To deploy gbot.py, follow these steps:

1. Clone the repository:

   .. code-block:: bash
   
      git clone https://github.com/oss-reva/gbot.py.git
      cd gbot.py

2. Install the package:

   .. code-block:: bash

      pip install .

To build and develop gbot.py, follow these steps:

1. Clone the repository:

   .. code-block:: bash
   
      git clone https://github.com/oss-reva/gbot.py.git
      cd gbot.py

2. Install the package in editable mode:

   .. code-block:: bash

      pip install -e .

Usage
-----

To use gbot.py, provide the Discord bot token as follows:

   .. code-block:: bash

      gbot --token DISCORD_BOT_TOKEN

Replace `DISCORD_BOT_TOKEN` with your actual Discord bot token.

Contributing
------------

If you'd like to contribute to this project, please read our `Contributing Guidelines`_.

License
-------

gbot.py is licensed under the MIT License. See the LICENSE_ file for details.

.. _LICENSE: https://github.com/virajsazzala/gbot.py/blob/main/LICENSE
.. _Contributing Guidelines: https://github.com/virajsazzala/gbot.py/blob/main/CONTRIBUTING.md
