A simple API wrapper for statcord.com to connect your bot and get your bot stats.
Project description
statcord.py
A simple API wrapper for statcord.com to connect your bot and get your bot stats.
Installation
Install via pip (recommended)
python3 -m pip install statcord.py
Features
- AUTOMATIC server & user counts updating.
- AUTOMATIC commands & active users updating.
- AUTOMATIC resource usage posting.
- AUTOMATIC custom function usage.
- Support provided via discord
Posting Server & User Counts, Active Users and Popular Commands.
Example Cogs System
from discord.ext import commands
import statcord
class StatcordPost(commands.Cog):
def __init__(self, bot):
self.bot = bot
self.key = "statcord.com-ADDYOURKEYHERE"
self.api = statcord.Client(self.bot,self.key,custom1=self.custom1,custom2=self.custom2)
self.api.start_loop()
@commands.Cog.listener()
async def on_command(self,ctx):
self.api.command_run(ctx)
async def custom1(self):
# Do Things Here
return "10" # Return a string.
async def custom2(self):
# Do Things Here
return "10" # Return a string.
def setup(bot):
bot.add_cog(StatcordPost(bot))
Example non-cogs system.
import discord
from discord.ext import commands
import statcord
bot = commands.Bot(command_prefix='!')
async def custom1(self):
# Do Things Here
return "10" # Return a string.
async def custom2(self):
# Do Things Here
return "10" # Return a string.
key = "statcord.com-ADDYOURKEYHERE"
api = statcord.Client(bot,key,custom1=custom1,custom2=custom2)
api.start_loop()
@bot.event
async def on_command(ctx):
api.command_run(ctx)
bot.run(TOKEN)
Configuration
To turn Memory tracking off, statcord.Client(bot,key,mem = False)
To turn CPU tracking off, statcord.Client(bot,key,cpu = False)
To activate a custom graph, statcord.Client(bot,key,custom1 = function)
Contributing
Contributions are always welcome!
Take a look at any existing issues on this repository for starting places to help contribute towards, or simply create your own new contribution to the project.
When you are ready, simply create a pull request for your contribution and we will review it whenever we can!
Donating
You can also help me and the project out by sponsoring me through a donation on PayPal.
Discussion, Support and Issues
Need support with this project, have found an issue or want to chat with others about contributing to the project?
Please check the project's issues page first for support & bugs!
Not found what you need here?
- If you have an issue, please create a GitHub issue here to report it, include as much detail as you can.
- Alternatively, You can join our Discord server to discuss any issue or to get support for the project.:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for statcord.py-3.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf650f4f75c6fb9fdb3a9b8d9758e545614af42cea0fb01e7db34af0d55d223e |
|
MD5 | a6b3bde572f236946057a54e031ee644 |
|
BLAKE2b-256 | 6feddc72cc03ea6b38cf4325fe350ebf2fafed34e38502615b6467ac2ec62156 |