Skip to main content

An API wrapper for Roblox written in Python.

Project description

# Pyblox

![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)
[![Travis](https://img.shields.io/travis/rust-lang/rust.svg)]()
[![ROBLOX API Discord](https://img.shields.io/badge/discord-roblox%20api%20chat-blue.svg)](https://discord.gg/EDXNdAT)

An API wrapper for Roblox written in Python.

The purpose of this API wrapper is to expose Roblox's API for third party use and/or for individual standalone projects.
This is the first stable Python API wrapper for the Roblox API. Documentation can be found within each module. I encourage
developers to look into the codebase to better understand this wrapper and what it can truly offer.

If you would like to contribute, create a pull request with the changes you made. If you have a complaint, issue or problem, create an issue and I will try to answer as fast as I can.

For user's wanting a Python 2x-compatible version: https://github.com/Sanjay-B/Pyblox/tree/python2

### Updating

The Roblox API updates whenever necessary and often the developers don't specify when or why these changes are taking place.
Due to this, this repo could break at anytime. If a break does occur, please open up an issue on this repo detailing the error.

## Installing

To install Pyblox to your windows machine, you must do the following:
```
1. Download or Clone this repo
2. Place the "pyblox" folder into C:\Users\YOURUSERNAMEONWINDOWSMACHINE\AppData\Local\Programs\Python\Python35-32\Lib\site-packages
```
MacOS and Linux are supported but installation will vary.
This was developed on a windows-based machine and thus, it's recommended to use windows.

## Quick Example

```py
from pyblox import Friends # Imports the Friends class from pyblox wrapper

def GetAllFriends():
CoolPeople = Friends.friendList(1) # Gets Friends List, page 1
print(CoolPeople) # Returns usernames and prints them on console

GetAllFriends() # Calls "GetAllFriends" method
```

## Requirements

- Python 3+
- ``pip install requests``

*note: requests may have been already installed.*
*pyblox may be compatible with python 2x. However, it has not been tested.*

## Related Projects
https://github.com/sentanos/roblox-js
https://github.com/CrescentCode/RobloxCommunication
https://github.com/CrescentCode/Freya
https://github.com/NoahCristino/robloxlib
https://github.com/winfamy/nodeblox
https://github.com/gamenew09/RobloxAPI
https://github.com/NevermoreFramework/Nevermore

Project details


Release history Release notifications

This version
History Node

2.4.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pyblox3-2.4.1.tar.gz (4.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page