Merge pull request #42 from mensch272/bots

Hostable discord bot

Author: m-haisham

CHANGELOG.md

@@ -14,6 +14,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Added pre-commit checks for consistent style
 - Added pre-commit badge to README.md
 - Added change log to database migrations README.md
+- Added discord bot with (most functions are only available in private):
+  - Download novel to multiple formats
+  - Search for novels using a query
+- Added alternative method to acquire package version if importlib fails
 
 ### Changed
 

Procfile

@@ -0,0 +1 @@
+bot: python -m novelsave runbot discord

README.md

@@ -2,20 +2,21 @@
 
 ![PyPI](https://img.shields.io/pypi/v/novelsave)
 ![Python Version](https://img.shields.io/badge/Python-v3.8-blue)
-![Repo Size](https://img.shields.io/github/repo-size/mensch272/novelsave)
-[![Contributors](https://img.shields.io/github/contributors/mensch272/novelsave)](https://github.com/mensch272/novelsave/graphs/contributors)
 ![Last Commit](https://img.shields.io/github/last-commit/mensch272/novelsave/main)
 ![Issues](https://img.shields.io/github/issues/mensch272/novelsave)
 ![Pull Requests](https://img.shields.io/github/issues-pr/mensch272/novelsave)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/mensch272/novelsave/main.svg)](https://results.pre-commit.ci/latest/github/mensch272/novelsave/main)
 [![License](https://img.shields.io/github/license/mensch272/novelsave)](LICENSE)
+![Discord](https://img.shields.io/discord/911120379341307904)
 
 This is a tool to download and convert novels from popular sites to e-books.
 
 > **v0.7.+ is not compatible with previous versions**
 
 ## Install
 
+### Local
+
 ```bash
 pip install novelsave
 ```
@@ -26,6 +27,32 @@ or
 pip install git+https://github.com/mensch272/novelsave.git
 ```
 
+### Chatbots
+
+#### Discord
+
+Join our server: https://discord.gg/eFgtrKTFt3
+
+##### Environmental Variables
+
+The default environmental variables are shown below. Modify them to your liking when deploying.
+
+`DISCORD_TOKEN` is required, others are optional.
+
+```shell
+DISCORD_TOKEN=  # Required: discord bot token
+DISCORD_SESSION_TIMEOUT=10 # Minutes
+DISCORD_DOWNLOAD_THREADS=4
+DISCORD_SEARCH_LIMIT=20  # Maximum results to show
+DISCORD_SEARCH_DISABLED=no  # Disable search functionality
+```
+
+#### Heroku Deployment
+
+Fill out the following form and set the environmental variables.
+
+[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
+
 ## Usage
 
 ### Basic

novelsave/__init__.py

@@ -1,4 +1,15 @@
-from importlib.metadata import version
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version("novelsave")
+except PackageNotFoundError:
+    import re
+    from pathlib import Path
+
+    pyproject = Path(__file__).parent.parent / "pyproject.toml"
+    with pyproject.open("r") as f:
+        text = f.read()
+
+    __version__ = re.search(r'version = "(.+?)"', text).group(1)
 
-__version__ = version("novelsave")
 __source__ = "https://github.com/mHaisham/novelsave"

novelsave/__main__.py

@@ -1,5 +1,11 @@
-from .cli import main
+import sys
 
+from novelsave.client import cli
 
 if __name__ == "__main__":
-    main()
+    if sys.argv[1:] == ["runbot", "discord"]:
+        from novelsave.client.bots import discord
+
+        discord.main()
+    else:
+        cli.main()

novelsave/client/__init__.py

@@ -0,0 +1,6 @@
+from . import config
+from . import containers
+from . import bot
+from . import session
+from . import endpoints
+from .main import main

novelsave/client/bots/__init__.py

@@ -0,0 +1,16 @@
+import sys
+
+from loguru import logger
+
+from . import config
+
+logger.configure(**config.logger_config())
+
+try:
+    from nextcord.ext import commands
+except ImportError as e:
+    logger.exception(e)
+    sys.exit(1)
+
+
+bot = commands.Bot("$")

novelsave/client/bots/discord/__init__.py

@@ -0,0 +1,20 @@
+from nextcord.ext import commands
+
+
+async def direct_only(ctx: commands.Context):
+    """Custom direct only check
+
+    This check returns true when one of the below checks are true
+    - The message author is bot owner and is invoked with help
+    - The message is not from a guild
+    """
+    if await ctx.bot.is_owner(ctx.author) and ctx.invoked_with == "help":
+        return True
+
+    if ctx.guild is not None:
+        raise commands.CheckFailure(
+            f"You may not use this command inside a guild. "
+            f"Use the '{ctx.clean_prefix}dm' to start a private session.",
+        )
+
+    return True