-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
config.py
130 lines (128 loc) · 7.7 KB
/
config.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
from typing import Dict, Any
from get_images import get_images
from treebo_functions import before_media_send
config: Dict[str, Any] = {
"bot_description": "Treebo - A SciOly Discord Bot for Forestry ID", # short bot description
"bot_signature": "Treebo - A Forestry ID Bot", # signature for embeds
"prefixes": ["t.", "T."], # bot prefixes, primary prefix is first in list
"id_type": "trees", # stars, fossils, muscles, etc. - plural noun
"github_image_repo_url": None, # link to github image repo
"support_server": "https://discord.gg/2HbshwGjnm", # link to discord support server
"source_link": "https://github.com/tctree333/Treebo", # link to source code (may be hosted on github)
"name": "treebo", # all lowercase, no spaces, doesn't really matter what this is
# "members_intent": False, # whether the privileged members intent is enabled in the developer portal
"download_func": get_images, # asyncronous function that downloads images locally to download_dir
"refresh_images": False, # whether to run download_func once every 24 hours with None as an argument
"evict_images": True, # whether to delete items from download_dir
"evict_frequency": 3.0, # how often to run eviction function
"evict_threshold": 2, # the number of times a specimen is seen before eviction
"max_evict": 2, # how many specimens to evict at a time
"evict_func": get_images, # function to run during eviction
"download_dir": "images/", # local directory containing media (images)
"data_dir": "data/", # local directory containing the id data
"group_dir": "taxon/", # directory within data_dir containing group lists
# "state_dir": "state/", # directory within data_dir containing alternate lists
# "default_state_list": "NATS", # name of the "state" that should be considered default
# "wikipedia_file": "wikipedia.txt", # filename within data_dir containing wiki urls for every item
# "prompt_file": "prompt.txt",
# "meme_file": None,
"logs": True, # enable logging
"log_dir": "logs/", # directory for text logs/backups
"bot_files_dir": "bot_files", # folder for bot generated files (downloaded images, logs)
"short_id_type": "t", # short (usually 1 letter) form of id_type, used as alias for the pic command
"invite": "https://discord.com/oauth2/authorize?client_id=990375195015544883&permissions=51200&scope=bot", # bot server invite link
"authors": "person_v1.32", # creator names
"extra_about_fields": [
{
"name": "Privacy Policy",
"value": "By using this bot, you agree to our [Privacy Policy](https://sciolyid.org/privacy/).",
},
{
"name": "Attribution",
"value": "Images used by this bot are the copyright of their respective owners. These images are sourced from [iNaturalist](https://www.inaturalist.org/).",
},
], # list of dicts containing keys "name" and "value" to be added to the botinfo command
"category_name": "taxon", # space thing, bird order, muscle group - what you are splitting groups by
"category_aliases": { # aliases for categories
"anacardiaceae": ["cashew", "sumac"],
"annonaceae": ["custard", "apples"],
"aquifoliaceae": ["holly"],
"arecaceae": ["palm", "palms", "palmae"],
"asparagaceae":["agave", "allies"],
"betulaceae": ["birch"],
"bignoniaceae": ["bignonia"],
"cactaceae": ["cactus"],
"caprifoliaceae": ["honeysuckle", "elder"],
"cornaceae": ["dogwood"],
"cupressaceae": ["cypress"],
"ebenaceae": ["ebony", "persimmon"],
"ericaceae": ["heath"],
"euphorbiaceae": ["spurge"],
"fabaceae": ["leguminosae", "legume", "legumes"],
"fagaceae": ["beech"],
"ginkgoaceae": ["ginkgo"],
"hamamelidaceae": ["witch-hazel", "witch", "hazel"],
"hippocastanaceae": ["buckeye"],
"juglandaceae": ["walnut"],
"lauraceae": ["laurels"],
"magnoliaceae": ["magnolia"],
"malvaceae": ["tiliaceae", "basswood", "mallow", "hibiscus"],
"moraceae": ["mulberry", "fig"],
"myrtaceae": ["myrtle"],
"nyssaceae": ["tupelo"],
"oleaceae": ["olive"],
"paulowniaceae":["foxglove"],
"pinaceae": ["pine"],
"platanaceae": ["sycamore", "plane"],
"rosaceae": ["rose"],
"rutaceae": ["citrus", "rue"],
"salicaceae": ["willow"],
"sapindaceae": ["aceraceae", "soapberry", "maple"],
"simaroubaceae": ["quassia"],
"taxaceae": ["yew"],
"theaceae": ["tea", "camellia"],
"ulmaceae": ["elm"],
},
# "disable_extensions": [], # bot extensions to disable (media, check, skip, hint, score, sessions, race, other)
"custom_extensions": ["treebo_ext"], # custom bot extensions to enable
"hooks": {"before_media_send": before_media_send},
"sentry": True, # enable sentry.io error tracking
"local_redis": False, # use a local redis server instead of a remote url
"bot_token_env": "BOT_TOKEN", # name of environment variable containing the discord bot token
# "sentry_dsn_env": "SENTRY_DISCORD_DSN", # name of environment variable containing the sentry dsn
"redis_env": "REDIS_URL", # name of environment variable containing the redis database url
"backups_channel": None, # discord channel id to upload database backups (None/False to disable)
# "backups_dir": "backups/", # directory to put database backup files before uploading
"holidays": True, # enable special features on select holidays
"sendas": True, # enable the "sendas" command
### WEB STUFF
# "client_id": 1234567890, # discord client id
# "base_image_url": None, # root of where images are hosted
# "validation_repo_url": None, # github repo where images are temporarily held
# "tmp_upload_dir": "uploaded/", # directory for temporary file storage
# "validation_local_dir": "validation_repo/", # directory for cloning the validation repo
# "git_token_env": "GIT_TOKEN", # environment variable with github auth token
# "git_user_env": "GIT_USERNAME", # environment variable with github auth token
# "git_email_env": "GIT_EMAIL", # environment variable with github auth token
# "validation_repo_dir": "", # directory in validation repo to store files
# "hashes_url": [], # urls to raw hashes.csv file in both image repos
# "ids_url": [], # urls to raw ids.csv file in both image repos
# "commit_url_format": [], # a format string for commit urls to both repos - image repo is first, validation repo is second
# "sentry_web_dsn_env": "SENTRY_API_DSN", # name of environment variable containing the sentry dsn
# "celery_broker_env": "CELERY_BROKER_URL", # name of environment variable with the database url for celery (broker)
# "secret_key_env": "FLASK_SECRET_KEY", # name of environment variable for signed cookies secret key
# "frontend_url_env": "FRONTEND_URL", # name of environment variable for frontend url
# "client_secret_env": "DISCORD_CLIENT_SECRET", # name of environment variable for discord client secret
# "discord_webhook_env": "DISCORD_WEBHOOK_URL", # webhook url for discord notification log
# "discord_webhook_disable": [
# "verify"
# ], # types of webhooks to disable ("add", "verify", "valid", "error")
# "verification_server": None, # invite to special discord server for people adding images, default to support server
# "disable_upload": True, # disable user uploads
# "disable_validation": False, # disable validation
# "validation_thresholds": { # number of flags of each type to move the image on during validation
# "invalid": 3,
# "duplicate": 3,
# "valid": 3,
# },
}