Merge pull request #10 from Galarzaa90/develop

v1.0.0

.coveragerc

@@ -5,4 +5,5 @@ include =
 [report]
 exclude_lines =
     pragma: no cover
-    if __name__ == .__main__.:
+    if __name__ == .__main__.:
+    __repr__

.gitignore

@@ -1,5 +1,6 @@
 # User files
 config.json
+config.yml
 *.data
 
 # IDEs

CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
+## Version 1.0.0 (2019-07-09)
+- Now using YAML instead of json for configuration.
+- Now announces guildhall changes.
+- Interval between scans is now configurable.
+- Removed some configurable values that made the config file more complex.
+
 ## Version 0.2.0 (2018-08-24)
 - GuildWatcher can now detect invites
     - Announces when a new character is invited

README.md

@@ -33,12 +33,11 @@ pip install -r requirements.txt
 1. Click on **Create Webhook**.
 1. Customize the avatar as needed.
 1. Copy the webhook's URL.
-1. Create a file named **config.json** and edit it, basing it on **config-example.json**.
+1. Create a file named **config.yml** and edit it, basing it on **config-example.yml**.
     * The top level `webhook_url` will be used, but if you want another guild to use a different URL, you can specify one for that guild.
-    * If `override_image` is added to the guild, its logo will be used instead.
 
 ## Running the script
-- `config.json` must be in the same directory you're running the script from.
+- `config.yml` must be in the same directory you're running the script from.
 - The script generates `.data` files, named after the guilds, these save the last state of the guild, to compare it with the current state.
 
 If installed using pip, you can run the script in one of two ways:
@@ -53,22 +52,26 @@ python -m guildwatcher
 ```
 
 ## Current Features
-* Announces when a member joins.
-* Announces when a member leaves or is kicked.
-* Announce when a member is promoted or demoted.
-* Announce when a member changes name.
-* Announce when a member's title is changed.
-* Announce when a new character is invited.
-* Announce when an invitation is revoked or rejected.
-* Multiple guilds support.
-* Webhook URL configurable per guild.
+- Announces when a member joins.
+- Announces when a member leaves or is kicked.
+- Announce when a member is promoted or demoted.
+- Announce when a member changes name.
+- Announce when a member's title is changed.
+- Announce when a new character is invited.
+- Announce when an invitation is revoked or rejected.
+- Announce when the guildhall changes.
+- Multiple guilds support.
+- Configurable scan times.
+- Webhook URL configurable per guild.
 
 ## Known Issues
-* Renaming a rank would trigger all rank members getting announced as leaving and joining back.
+- Renaming a rank would trigger all rank members getting announced as leaving and joining back.
 
 ## Planned features
-* Configurable scan times.
-* Announce changes in guild attributes.
+
+- Announce changes in guild attributes.
+    - Application status
+    - Disband warning
 
 ## Example
 ![image](https://user-images.githubusercontent.com/12865379/29383497-7df48300-8285-11e7-83c3-f774ad3a43a8.png)

config-example.yml

@@ -0,0 +1,15 @@
+# To use this file, rename it to config.yml
+
+webhook_url: http://discord.webhook.url.goes.here
+
+# Time in seconds to wait between checks.
+interval: 300
+
+# Remember to write the title with the correct casing.
+guilds:
+  - Redd Alliance
+  - Bald Dwarfs
+  # If you want to override the channel, you must use this format for that entry
+  # The changes of this guild will be posted on a different channel.
+  - name: Academy
+    webhook_url: http://another.webhook.url.goes.here