Skip to content

Commit 88f4d6f

Browse files
davidhozicdavidhozic
authored
Merge pull request #249 from davidhozic/develop
Documentation (#248)
2 parents da3d195 + 364902c commit 88f4d6f

File tree

16 files changed

+118
-160
lines changed

16 files changed

+118
-160
lines changed

‎Examples/Automatic Generation/autochannel.py‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,11 @@ async def main():
88
token="SomeToken",
99
is_user=False,
1010
servers=[
11-
daf.GUILD(
12-
snowflake=123456789,
13-
messages=[
14-
daf.TextMESSAGE(
15-
None, timedelta(seconds=5), "Hello World",
16-
channels=daf.message.AutoCHANNEL("shill", exclude_pattern="shill-[7-9]")
17-
)
18-
],
19-
logging=True
20-
)
11+
daf.GUILD(snowflake=123456789,
12+
messages=[
13+
daf.TextMESSAGE(None, timedelta(seconds=5), "Hello World", channels=daf.message.AutoCHANNEL("shill", exclude_pattern="shill-[7-9]"))
14+
],
15+
logging=True)
2116
]
2217
)
2318
)

‎Examples/Automatic Generation/autoguild.py‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,14 @@
88
token="SomeToken",
99
is_user=False,
1010
servers=[
11-
daf.guild.AutoGUILD(
12-
include_pattern="NFT-Dragons", # Regex pattern of guild names that should be included
13-
exclude_pattern="NonFunctionalTesticle", # Regex pattern of guild names that should be excluded
14-
remove_after=None, # Never stop automatically managing guilds
15-
messages=[ # Pre-include messages
16-
daf.message.TextMESSAGE(None, timedelta(seconds=5), "Buy our NFT today!",daf.guild.AutoCHANNEL("shill", "promo", timedelta(seconds=60)))
17-
],
18-
logging=True, # The generated GUILD objects will have logging enabled
19-
interval=timedelta(hours=1) # Scan for new guilds in a period of one hour
20-
)
11+
daf.guild.AutoGUILD( include_pattern="NFT-Dragons", # Regex pattern of guild names that should be included
12+
exclude_pattern="NonFunctionalTesticle", # Regex pattern of guild names that should be excluded
13+
remove_after=None, # Never stop automatically managing guilds
14+
messages=[
15+
daf.message.TextMESSAGE(None, timedelta(seconds=5), "Buy our NFT today!", daf.message.AutoCHANNEL("shill", "promo", timedelta(seconds=60)))
16+
],
17+
logging=True, # The generated GUILD objects will have logging enabled
18+
interval=timedelta(hours=1) ) # Scan for new guilds in a period of one hour
2119
]
2220
)
2321
]

‎Examples/Automatic Generation/find_promo_channels.py‎

Lines changed: 0 additions & 57 deletions
This file was deleted.

‎Examples/Dynamic Modification/main_add_object.py‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,13 @@
66
import daf
77

88

9-
# Create a list in which we will automatically add guilds
10-
allowed_strings = {"shill", "advert", "promo"}
11-
data_to_shill = ( # Example data set
12-
"Hello World",
13-
daf.discord.Embed(title="Example Embed",
14-
color=daf.discord.Color.blue(),
15-
description="This is a test embed")
16-
)
17-
189
async def user_task():
1910
# Returns the client to send commands to discord, for more info about client see https://docs.pycord.dev/en/master/api.html?highlight=discord%20client#discord.Client
2011
account = daf.ACCOUNT(token="ASDASJDAKDK", is_user=False)
12+
2113
guild = daf.GUILD(snowflake=123456)
14+
15+
data_to_shill = ( "Hello World", daf.discord.Embed(title="Example Embed", color=daf.discord.Color.blue(), description="This is a test embed") )
2216
text_msg = daf.TextMESSAGE(None, timedelta(seconds=5), data_to_shill, [12345, 6789], "send", timedelta(seconds=0))
2317

2418
# Dynamically add account
@@ -36,4 +30,3 @@ async def user_task():
3630
############################################################################################
3731
if __name__ == "__main__":
3832
daf.run(user_callback=user_task)
39-

‎Examples/Dynamic Modification/main_remove_object.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import daf
66

77
accounts = [
8-
daf.ACCOUNT(
8+
account := daf.ACCOUNT(
99
token="SDSADSDA87sd87",
1010
is_user=False,
1111
servers=[
@@ -16,7 +16,7 @@
1616

1717

1818
async def user_task():
19-
guild = accounts[0].servers[0]
19+
guild = account.servers[0]
2020
await daf.remove_object(guild)
2121

2222

‎Examples/Dynamic Modification/main_update.py‎

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,11 @@
1111
import daf
1212

1313

14-
1514
message = daf.TextMESSAGE(None, timedelta(seconds=5), "Hello", [123455, 1425215])
1615
accounts = [
17-
daf.ACCOUNT(
18-
token="SKJDSKAJDKSJDKLAJSKJKJKGSAKGJLKSJG",
19-
is_user=False,
20-
servers=[
21-
daf.GUILD(1234567, [
22-
message
23-
]
24-
)
25-
]
26-
)
16+
daf.ACCOUNT( token="SKJDSKAJDKSJDKLAJSKJKJKGSAKGJLKSJG",
17+
is_user=False,
18+
servers=[daf.GUILD(1234567, [message])] )
2719
]
2820

2921

@@ -33,12 +25,7 @@ async def user_task():
3325
await message.update(end_period=timedelta(seconds=20), data="World")
3426
# Will now send "World" every 20 seconds
3527

36-
#########################################################################
37-
38-
############################################################################################################################################################################
39-
4028

41-
############################################################################################
4229
if __name__ == "__main__":
4330
daf.run(user_callback=user_task, accounts=accounts)
4431

‎Examples/Logging/CSV files/main_rickroll.py‎

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,11 @@ def get(st):
1919
return item
2020

2121
accounts = [
22-
daf.ACCOUNT(
23-
token="SDASKDKLSADJKLSDJ",
24-
is_user=False,
25-
servers=[
26-
daf.GUILD(
27-
snowflake=12345,
28-
messages=[
29-
daf.TextMESSAGE(None, timedelta(seconds=5), get(rolls.copy()), [12345], "edit", timedelta(seconds=5))
30-
],
31-
logging=True
32-
)
33-
]
34-
)
22+
daf.ACCOUNT( token="SDASKDKLSADJKLSDJ",
23+
is_user=False,
24+
servers=[
25+
daf.GUILD(12345, [daf.TextMESSAGE(None, timedelta(seconds=5), get(rolls.copy()), [12345], "edit")], True)
26+
] )
3527
]
3628

3729

‎Examples/Logging/JSON files/main_rickroll.py‎

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,11 @@ def get(st):
1919
return item
2020

2121
accounts = [
22-
daf.ACCOUNT(
23-
token="SDASKDKLSADJKLSDJ",
24-
is_user=False,
25-
servers=[
26-
daf.GUILD(
27-
snowflake=12345,
28-
messages=[
29-
daf.TextMESSAGE(None, timedelta(seconds=5), get(rolls.copy()), [12345], "edit", timedelta(seconds=5))
30-
],
31-
logging=True
32-
)
33-
]
34-
)
22+
daf.ACCOUNT( token="SDASKDKLSADJKLSDJ",
23+
is_user=False,
24+
servers=[
25+
daf.GUILD(12345, [daf.TextMESSAGE(None, timedelta(seconds=5), get(rolls.copy()), [12345], "edit")], True)
26+
] )
3527
]
3628

3729

‎Examples/Logging/SQL Logging/rolls.py‎

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,11 @@ def get(st):
1919
return item
2020

2121
accounts = [
22-
daf.ACCOUNT(
23-
token="SDASKDKLSADJKLSDJ",
24-
is_user=False,
25-
servers=[
26-
daf.GUILD(
27-
snowflake=12345,
28-
messages=[
29-
daf.TextMESSAGE(None, timedelta(seconds=5), get(rolls.copy()), [12345], "edit", timedelta(seconds=5))
30-
],
31-
logging=True
32-
)
33-
]
34-
)
22+
daf.ACCOUNT( token="SDASKDKLSADJKLSDJ",
23+
is_user=False,
24+
servers=[
25+
daf.GUILD(12345, [daf.TextMESSAGE(None, timedelta(seconds=5), get(rolls.copy()), [12345], "edit")], True)
26+
] )
3527
]
3628

3729

‎Examples/Message Types/DirectMESSAGE/main_data_function.py‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,18 @@ def get_data(parameter):
1515
return f"Parameter: {parameter}\nTimestamp: {l_time.day}.{l_time.month}.{l_time.year} :: {l_time.hour}:{l_time.minute}:{l_time.second}"
1616

1717
accounts = [
18-
daf.ACCOUNT(
18+
daf.ACCOUNT( # ACCOUNT 1
19+
"JJJKHSAJDHKJHDKJ",
20+
False,
21+
[
22+
daf.USER(123456789,
23+
[
24+
daf.DirectMESSAGE(None, timedelta(seconds=15), get_data(123)),
25+
],
26+
True)
27+
]
28+
),
29+
daf.ACCOUNT( # ACCOUNT 2
1930
token="JJJKHSAJDHKJHDKJ",
2031
is_user=False,
2132
servers=[

0 commit comments

Comments
 (0)