%global _empty_manifest_terminate_build 0 Name: python-smdb-api Version: 0.11.1 Release: 1 Summary: API package for Server Monitoring Discord Bot License: Freeware URL: https://github.com/NightKey/Server-monitoring-discord-bot Source0: https://mirrors.aliyun.com/pypi/web/packages/ce/81/e7a0e8cf88ef34a2f7a8ee2b84289ea9b455f37c88da494409cab3ef13cc/smdb_api-0.11.1.tar.gz BuildArch: noarch %description # Server monitoring Discord bot API This API can be used to interface with the server monitoring Discord bot only if the API is enabled on it. For this, the bot needs to run on the same PC, or the API needs to be set up to allow outside connections. ## Usage To create an api, import the package, and use the required arguments. ``` import smdb_api API = smdb_api.API("Test", "80716cbfd9f90428cd308acc193b4b58519a4f10a7440b97aaffecf75e63ecec") ``` Avaleable arguments: - name: string | Used to identify the application to the api server. - key: string | Used to verify identity with the api server. - ip: string (optional) | Used to set the api server's IP address. - port: integer (optional) | Used to set the api server's listening port. - update_function: function (optional) | Sets a callback function to call, when the api server updates. To initiate the connection, use the validate command. The validate function can get a timeout limit, so it won't hault the program, if the api server won't ansvear within a set time. ``` API.validate() server_status = API.get_status() ``` To add a command to the bot, use the 'create_function' command, like shown here: ``` [...] def my_callback(message): #Does something API.create_function("MyScript", "Some text to help\nUsage: &MyScript \nCategory: SERVER", my_callback) ``` To send a message to someone, use the 'send_message' command: ``` [...] discordId="##################" API.send_message("Test message to a channel", discordId) print(f"I sent a message to {API.get_username(discordId)}!") ``` Closing the connection safely is easy with the 'close' command. ``` [...] API.close("Some reason for the bot logger.") ``` ## Available commands ### validate This function connects to the API server and validates itself with it. If the validation was successful, it starts a listener thread. ### get_status This function retrieves the bot's status and returns it in a dictionary. ### get_username This command returns the given Discord ID's username. ### is_admin Determines if a user is admin in the bot's database. ### send_message This command allows you to send messages in the bot's name to selected users/channels or the default channel. ### create_function This command creates a function in the bot that can be called by a user. ### connect_to_voice This command connects the client to the user's voice channel ### disconnect_from_voice This command disconnects the client from the user's voice channel ### play_file Starts the audio file on the path provided. If the file is not supported error is returned. ### add_file Adds the audio file to the play list on the path provided. If the file is not supported error is returned. ### pause_currently_playing Pauses the currently playing track. ### resume_paused Resumes playing the paused track. ### skip_currently_playing Skips the current track if other tracks are in the play list. ### stop_currently_playing Stops the currently playing track. ### get_queue Lists the names of the items in the playlist, starting with the currently playing file. ### set_as_hook_for_track_finished Sets the callback for when the current tack finished playing for possible file removal. Returns the title of the finished track in a message object. ### subscribe_to_event Subscribes a callback to an event. Returns a string that represents the string value of the previous state, string that represents the string value of the new state, and a message object containing the dm channel for the user with the discord interface. %package -n python3-smdb-api Summary: API package for Server Monitoring Discord Bot Provides: python-smdb-api BuildRequires: python3-devel BuildRequires: python3-setuptools BuildRequires: python3-pip %description -n python3-smdb-api # Server monitoring Discord bot API This API can be used to interface with the server monitoring Discord bot only if the API is enabled on it. For this, the bot needs to run on the same PC, or the API needs to be set up to allow outside connections. ## Usage To create an api, import the package, and use the required arguments. ``` import smdb_api API = smdb_api.API("Test", "80716cbfd9f90428cd308acc193b4b58519a4f10a7440b97aaffecf75e63ecec") ``` Avaleable arguments: - name: string | Used to identify the application to the api server. - key: string | Used to verify identity with the api server. - ip: string (optional) | Used to set the api server's IP address. - port: integer (optional) | Used to set the api server's listening port. - update_function: function (optional) | Sets a callback function to call, when the api server updates. To initiate the connection, use the validate command. The validate function can get a timeout limit, so it won't hault the program, if the api server won't ansvear within a set time. ``` API.validate() server_status = API.get_status() ``` To add a command to the bot, use the 'create_function' command, like shown here: ``` [...] def my_callback(message): #Does something API.create_function("MyScript", "Some text to help\nUsage: &MyScript \nCategory: SERVER", my_callback) ``` To send a message to someone, use the 'send_message' command: ``` [...] discordId="##################" API.send_message("Test message to a channel", discordId) print(f"I sent a message to {API.get_username(discordId)}!") ``` Closing the connection safely is easy with the 'close' command. ``` [...] API.close("Some reason for the bot logger.") ``` ## Available commands ### validate This function connects to the API server and validates itself with it. If the validation was successful, it starts a listener thread. ### get_status This function retrieves the bot's status and returns it in a dictionary. ### get_username This command returns the given Discord ID's username. ### is_admin Determines if a user is admin in the bot's database. ### send_message This command allows you to send messages in the bot's name to selected users/channels or the default channel. ### create_function This command creates a function in the bot that can be called by a user. ### connect_to_voice This command connects the client to the user's voice channel ### disconnect_from_voice This command disconnects the client from the user's voice channel ### play_file Starts the audio file on the path provided. If the file is not supported error is returned. ### add_file Adds the audio file to the play list on the path provided. If the file is not supported error is returned. ### pause_currently_playing Pauses the currently playing track. ### resume_paused Resumes playing the paused track. ### skip_currently_playing Skips the current track if other tracks are in the play list. ### stop_currently_playing Stops the currently playing track. ### get_queue Lists the names of the items in the playlist, starting with the currently playing file. ### set_as_hook_for_track_finished Sets the callback for when the current tack finished playing for possible file removal. Returns the title of the finished track in a message object. ### subscribe_to_event Subscribes a callback to an event. Returns a string that represents the string value of the previous state, string that represents the string value of the new state, and a message object containing the dm channel for the user with the discord interface. %package help Summary: Development documents and examples for smdb-api Provides: python3-smdb-api-doc %description help # Server monitoring Discord bot API This API can be used to interface with the server monitoring Discord bot only if the API is enabled on it. For this, the bot needs to run on the same PC, or the API needs to be set up to allow outside connections. ## Usage To create an api, import the package, and use the required arguments. ``` import smdb_api API = smdb_api.API("Test", "80716cbfd9f90428cd308acc193b4b58519a4f10a7440b97aaffecf75e63ecec") ``` Avaleable arguments: - name: string | Used to identify the application to the api server. - key: string | Used to verify identity with the api server. - ip: string (optional) | Used to set the api server's IP address. - port: integer (optional) | Used to set the api server's listening port. - update_function: function (optional) | Sets a callback function to call, when the api server updates. To initiate the connection, use the validate command. The validate function can get a timeout limit, so it won't hault the program, if the api server won't ansvear within a set time. ``` API.validate() server_status = API.get_status() ``` To add a command to the bot, use the 'create_function' command, like shown here: ``` [...] def my_callback(message): #Does something API.create_function("MyScript", "Some text to help\nUsage: &MyScript \nCategory: SERVER", my_callback) ``` To send a message to someone, use the 'send_message' command: ``` [...] discordId="##################" API.send_message("Test message to a channel", discordId) print(f"I sent a message to {API.get_username(discordId)}!") ``` Closing the connection safely is easy with the 'close' command. ``` [...] API.close("Some reason for the bot logger.") ``` ## Available commands ### validate This function connects to the API server and validates itself with it. If the validation was successful, it starts a listener thread. ### get_status This function retrieves the bot's status and returns it in a dictionary. ### get_username This command returns the given Discord ID's username. ### is_admin Determines if a user is admin in the bot's database. ### send_message This command allows you to send messages in the bot's name to selected users/channels or the default channel. ### create_function This command creates a function in the bot that can be called by a user. ### connect_to_voice This command connects the client to the user's voice channel ### disconnect_from_voice This command disconnects the client from the user's voice channel ### play_file Starts the audio file on the path provided. If the file is not supported error is returned. ### add_file Adds the audio file to the play list on the path provided. If the file is not supported error is returned. ### pause_currently_playing Pauses the currently playing track. ### resume_paused Resumes playing the paused track. ### skip_currently_playing Skips the current track if other tracks are in the play list. ### stop_currently_playing Stops the currently playing track. ### get_queue Lists the names of the items in the playlist, starting with the currently playing file. ### set_as_hook_for_track_finished Sets the callback for when the current tack finished playing for possible file removal. Returns the title of the finished track in a message object. ### subscribe_to_event Subscribes a callback to an event. Returns a string that represents the string value of the previous state, string that represents the string value of the new state, and a message object containing the dm channel for the user with the discord interface. %prep %autosetup -n smdb_api-0.11.1 %build %py3_build %install %py3_install install -d -m755 %{buildroot}/%{_pkgdocdir} if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi pushd %{buildroot} if [ -d usr/lib ]; then find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/lib64 ]; then find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/bin ]; then find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/sbin ]; then find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi touch doclist.lst if [ -d usr/share/man ]; then find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst fi popd mv %{buildroot}/filelist.lst . mv %{buildroot}/doclist.lst . %files -n python3-smdb-api -f filelist.lst %dir %{python3_sitelib}/* %files help -f doclist.lst %{_docdir}/* %changelog * Fri Jun 09 2023 Python_Bot - 0.11.1-1 - Package Spec generated