Skip to main content

FiveMpy

A python wrapper in order to interact with FiveM API & FiveM servers

How-to install :

pip install fivempy

How-to use : There is two class : Server and Fivem

Server

import fivempy

server = fivempy.Server("ip:port")
#default port is 30120

It initialize a Server Class with those attributes:

players: [{
        "endpoint"; string,
        "id": int,
        "identifiers": array,
        "name": string,
        "ping": int,
}],
info: {
    "enhancedHostSupport": boolean,
    "icon": string, // Icon of the server (Base64)
    "resources": array, // All started resources
    "server": string, // FXServer's version (string format)
    "vars": { // Some convars defined in server.cfg
        "sv_enhancedHostSupport": boolean,
        "sv_lan": boolean,
        "sv_licenseKeyToken": string,
        "sv_maxClients": int,
        "sv_scriptHookAllowed": boolean,
        "sv_hostname": string,
    },
    "version": int, // FXServer's version (numeric format)
},
dynamic: {
    "clients": int, // number of online player
    "gametype": string,
    "hostname": string,
    "iv": string, // FXServer's version (string format)
    "mapname": string,
    "sv_maxclients": string // number of maximum players
},
ip : string, // server's ip:port
player_count: int, // number of online players
player_max: int, // number of maximum players
player_list: list // list of online players

Fivem

import fivempy

fivem = fivempy.Fivem()

It initialize a Fivem Class with those attributes:

status: {
    "indicator": string, // "none", "minor", "major", or "critical"
    "description": string // "All Systems Operational", "Partial System Outage", or "Major Service Outage"
},
forum_status, policy_status, cnl_status, keymaster_status, serverlist_status, runtime_status: {
    "name": string, // names of different components
    "status": string, // operational, degraded_performance, partial_outage, or major_outage
    "description": string, // description of the service
}

Metadata

Release files for fivempy 0.2.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fivempy 0.2.6
File Size Uploaded Provenance Actions
fivempy-0.2.6.tar.gz 3.2 kB Without provenance Details for fivempy-0.2.6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for fivempy 0.2.6
File Interpreter ABI Platform Actions
fivempy-0.2.6-py3-none-any.whl Python 3 none any Details for fivempy-0.2.6-py3-none-any.whl

Total release size: 6.9 kB

Release files / fivempy-0.2.6.tar.gz

Download URL fivempy-0.2.6.tar.gz
Size 3.2 kB
Tags Source
SHA-256 checksum
How to use checksums
247a20965683ff1878c07217a146e755823fc02a6665e5f81c6f249c8c077052
BLAKE2b-256 checksum
How to use checksums
2fd7a85f7ebf6724946ba1fb8eac96c509c8c3ed16fe59b80c0b5ce002e307e4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

Release files / fivempy-0.2.6-py3-none-any.whl

Download URL fivempy-0.2.6-py3-none-any.whl
Size 3.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1bccd0160a1ebd2569e63b7ac75d7a677a6a659edec6149a6b51957969673f20
BLAKE2b-256 checksum
How to use checksums
a9c36a0b71af01cd7fe1b3ac9b6c1e5227a146f184ae12c933e26c6fcd1c5bc7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

Security for fivempy 0.2.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page