Skip to main content

A small package for the founders api

Project description

FoundersApiPy

A small package for the Founders API access made into a python package!

Index:

Package:

import founders

Sub Packages:

user:

founders.user.info(id): returns a user_info class based on user id input.

founderse.user.all(): returns a dictionary of all users in the form of {username: id, username: id...}.

server:

founders.server.info(id): returns a server_info class based on server id input.

founders.server.all(): returns a dictionary of all servers in the form of {server_name: id, server_name: id...}.

status:

founders.status.stat(id): returns a status_info class based on server id input.

Classes:

user_info:

self.success: True/False - whether information was obtained. This should always be checked before using information!

self.username: username of user.

self.rank: rank of user.

self.servers: servers user has access to.

self.lastSeen: time when user was last on in unix epoch time

self.created: time when user account was created in unix epoch time

server_info:

self.success: True/False - whether information was obtained. This should always be checked before using information!

self.domain: The domain name of the server; Ex: hypixel.net.

self.ip: The ip adress of the server, Ex: 172.65.128.70

self.port: The port of the server (by default and usually 25565).

self.name: The name of the server in the Founders Server Board; Ex: Hypixel

self.mRam: Minimum ram allocated to the server.

self.xRam: Maximum ram allocated to the server.

self.serverJar: Type of Minecraft server jar often pertaining to the Minecraft version, Ex: spigot-1.14.4.

status_info:

self.success: True/False - whether information was obtained. This should always be checked before using information!

self.status: True/False - whether the server is running or not.

self.ip: The ip adress of the server, Ex: 172.65.128.70

self.port: The port of the server (by default and usually 25565).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

founders-0.1.1.tar.gz (3.0 kB view hashes)

Uploaded Source

Built Distribution

founders-0.1.1-py3-none-any.whl (16.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page