Bot should work now, added functionality - see commit

.gitignore

@@ -1,4 +1,148 @@
-*.log
-*.cfg
-/.vscode
-.pylintrc
+*.log
+*.cfg
+*.sqlite
+/.vscode
+.pylintrc
+/__pycache__
+Procfile
+*.code-workspace
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

.gitmessage

@@ -0,0 +1,10 @@
+[commit title]
+
+#<issueNum>: [commit title]
+
+Closes #<issueNum>: [commit title]
+
+<ChangeDetails>
+    <ChangeDescription>description</ChangeDescription>
+    <ChangeReasoning>reasoning</ChangeReasoning>
+</ChangeDetails>

CONFIG.py

@@ -0,0 +1,21 @@
+import os
+import pathlib
+
+discord_token = "YOUR_TOKEN_HERE"
+client_id = "YOUR_CLIENT_ID"
+prefix = "YOUR_PREFIX_HERE"
+bot_folder = "YOUR_STORAGE_FOLDER_NAME_HERE"
+cfg_name = "botdata.cfg"
+sqlite_name = "santabotdb.sqlite"
+dbg_name = "debug.log"
+role_channel = -1
+min_budget = 10
+max_budget = 20
+
+
+###############################################
+###           DO NOT CHANGE BELOW           ###
+###############################################
+cfg_path = os.path.join(str(pathlib.Path(__file__).parent), bot_folder, cfg_name)
+sqlite_path = os.path.join(str(pathlib.Path(__file__).parent), bot_folder, sqlite_name)
+dbg_path = os.path.join(str(pathlib.Path(__file__).parent), bot_folder, dbg_name)

CONFIG.py.example

@@ -0,0 +1,21 @@
+import os
+import pathlib
+
+discord_token = "ABCDEFGHIJKLMNOPQRSTUVWXYZ.1234567890"
+client_id = "0123456789"
+prefix = "s!"
+bot_folder = "files"
+cfg_name = "botdata_example.cfg"
+sqlite_name = "santabotdb_example.sqlite"
+dbg_name = "debug_example.log"
+role_channel = 9876543210
+min_budget = 10
+max_budget = 20
+
+
+###############################################
+###           DO NOT CHANGE BELOW           ###
+###############################################
+cfg_path = os.path.join(str(pathlib.Path(__file__).parent), bot_folder, cfg_name)
+sqlite_path = os.path.join(str(pathlib.Path(__file__).parent), bot_folder, sqlite_name)
+dbg_path = os.path.join(str(pathlib.Path(__file__).parent), bot_folder, dbg_name)

README.md

@@ -1,23 +1,123 @@
-#SantaBot
+# SantaBot
 
-A Discord bot to organize secret santa gift exchanges using the discord.py Python library
+A Discord bot to organize secret santa gift exchanges using the discord.py Python library + some other admin-type stuff for my server
 
-##Instructions: 
+- This bot code must be pulled (or forked) and run locally
+- If you don't want the admin-type stuff, just go in and comment out the add_cog(SantaAdministrative(...)) line
 
-###Installation and Dependencies:
+### Requirements
+- python 3.6 or later (can be installed [here](https://www.python.org/downloads/))
+- pip3
 
-To add this bot to your Discord server, first ensure you have [Python version 3.5 or later installed](https://www.python.org/downloads/), along with [the discord.py library](https://github.com/Rapptz/discord.py) and [the configobj library](https://www.voidspace.org.uk/python/configobj.html#downloading). The asyncio, logging, os.path, and random libraries are also required, but they should be included in most Python installations by default. 
+### Steps to run:
+1. Run `pip3 install -r requirements.txt`
+2. Once all of the dependencies are installed, create a Discord bot token following the instructions [here](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token).
+   - **IMPORTANT:** you will need to explicitly enable the Server Members Intent under the Bot tab in the [Discord Application Developer Portal](https://discord.com/developers/applications/) ![as pictured](https://i.imgur.com/mvwTiPE.png)
+3. Replace variables in CONFIG.py (I have provided CONFIG.py.example as an example)
 
-Once all of the dependencies are installed, create a Discord bot token following the instructions [here](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token). Then, open the santa-bot.py file with your favorite plaintext editor, and replace the word `'token'` in the last line that reads `client.run('token')` with the token you have generated, keeping the single quotes. The santa-bot.py file can now be excecuted, and the bot should function as normal.
+   3a. Replace `discord_token` and `client_id` in CONFIG.py with your bot token - these two are REQUIRED for all functionality and for the bot to even start
 
-###Bot Commands:
+   3b. Replace other variables as you want
 
-- `$$join` adds you to the list of secret santa participants.
-- `$$setaddress` saves your mailing address for gifts to be sent to.
-- `$$setprefs` saves your gift preferences so your secret santa will know what kind of things you would like to receive. Keep in mind that your exact input is sent to your secret santa as is. 
-- `$$listparticipants` makes the bot list all of the people currently participating in the secret santa exchange.
-- `$$totalparticipants` makes the bot give the number of people currently participating in the secret santa exchange
-- *`$$start` to have the bot assign each participant a partner
-- *`$$shutdown` to make the bot self-terminate
+       - `role_channel` is REQUIRED for using reaction roles - will print an error in the console if left as -1
 
-all commands marked with a * can only be run by a server admin.
+       - `prefix` change it to whatever you want otherwise commands default to YOUR_PREFIX_HEREjoin, YOUR_PREFIX_HEREunpin_all, etc.
+
+       - `bot_folder` this is where the .cfg for the Secret Santa participants, the debug log, and the SQLite database files are stored
+
+       - `cfg_name`, `dbg_name`, `sqlite_name` don't *need* to do anything here unless you want to
+
+       - `min_budget`, `max_budget` are used for the Secret Santa functionality and can be changed depending on what your Discord server agrees upon.
+4. Run `python3 santa-bot.py`
+
+### Add a Systemd Service for SantaBot to Autostart on Reboot
+To keep SantaBot running even after restart you can create a service.
+
+1. Copy the `run_santa.sh` to `/usr/local/bin/` directory
+
+- sudo cp run_santa.sh /usr/local/bin/
+
+2. Edit `run_santa.sh` in `/usr/local/bin` with your favorite editor to include the absolute path to the santa-bot.py script. For example `/home/pi/Santabot/santa-bot.py`. If you're not sure the absolute, in the Santabot directory type `pwd`
+
+- pwd
+  /home/pi/Santabot
+- sudo nano /usr/local/bin/run_santa.sh
+
+		- while true
+		- do
+    		-    python3 /home/pi/Santabot/santa-bot.py
+		-    sleep 10
+		- done
+
+
+3. Create a service file or edit the included `santabot.service` using your favorite text editor and add the default user name to `User=` and the Group they belong to in `Group=`. To find out what default group a user belongs use `id -gn usernamehere`
+
+- nano santabot.service
+
+		- [Unit]
+		- Description=Santa Discord Bot
+
+		- [Service]
+		- User= root
+		- Group= root
+		- Restart=on-abort
+		- WorkingDirectory= "Full Path to Santa Bot Here"
+		- ExecStart= /usr/local/bin/run_santa.sh
+
+		- [Install]
+		- WantedBy=multi-user.target
+
+4. Copy the santabot.service to `/lib/systemd/system/`
+
+- sudo cp santabot.service /lib/systemd/system/
+
+5. Enable the service so it will autostart on reboot, then start with the commands:
+
+- sudo systemctl enable santabot.service
+- sudo systemctl start santabot.service
+
+6. Then check the status
+
+- sudo systemctl status santabot.service
+
+7. When done using the bot for the season, to disable use both commands:
+
+- sudo systemctl disable santabot.service
+- sudo systemctl stop santabot.service
+
+#### FAQ:
+1. What if my wishlist URL or preference is multiple words?
+   - The bot supports that, just surround it with quotation marks. (e.g. `s!setprefs dog "stuffed rabbit" cat`)
+2. Does the wishlist *have* to be a URL? What if one of the Secret Santas prefers sending handmade gifts?
+   - No that field is really about having a destination for users to send their gifts. Feel free to use addresses instead of URLs if you so desire. Keep in mind that addresses will need to follow question #1 of this FAQ (e.g. `s!setwishlisturl amazonurl/123 "P Sherman 42 Wallaby Way" rightstufanime`)
+
+#### Secret Santa Commands:
+
+- `s!join` = join the Secret Santa
+- `s!leave` = leave the Secret Santa
+- `s![setwishlisturl|swlurl] [wishlist URL]` = set your wishlist URL (replaces current). You may also add your mailing address. __wishlist URL is required__.
+- `s![getwishlisturl|gwlurl]` = bot will PM you your current wishlist
+- `s![setprefs|sprefs] [specific preferences, the things you like]` = set preferences (replaces current). Put N/A if none. __preferences are required__.
+- `s![getprefs|gprefs]` = bot will PM you your current preferences
+- `s![listparticipants|lp]` **(admin only)** = get the current participants
+- `s![totalparticipants|tp]` = get the total number of participants
+- `s!partnerinfo` = be DM'd your partner's information
+- `s!start` **(admin only)** = assign Secret Santa partners
+- `s!restart` **(admin only)** = attempt to restart Secret Santa after pause without changing partners
+- `s!pause` **(admin only)** = pause Secret Santa (will require `s!start` and will reshuffle partners)
+- `s!end` **(admin only)** = end Secret Santa
+
+#### Administrative Commands:
+- `s!assign_role_channel CHANNEL` **(admin only)** = change the channel the bot looks at for reaction roles
+- `s!archive_pins SRC_CHANNEL DEST_CHANNEL` **(admin only)** = archive all pins from the source channel to the destination channel as messages (ex. `s!archive_pins #general #archive`)
+- `s!unpin_all [CHANNEL_ID]` **(admin only)** = unpin all messages in the indicated channel (defaults to the channel the command is called in)
+
+#### Utility Commands:
+- `s!emote [any number of emotes]` = returns the URL of the emote image/gif for convenience
+- `s![countdown|cd]` = set/check a countdown (global for the server, e.g. time until a Manga Club event) - help text is returns as needed
+
+#### Miscellaneous Commands:
+
+- `s!ping` = check if bot is alive
+- `s!echo` = make the bot say stuff
+- `s!ding` = dong