https://github.com/stamtsag/basicpyapi

A barebones websockets server & client, in python.
https://github.com/stamtsag/basicpyapi

api client python server websockets

Last synced: about 1 year ago
JSON representation

A barebones websockets server & client, in python.

• Host: GitHub
• URL: https://github.com/stamtsag/basicpyapi
• Owner: StamTsag
• License: mit
• Created: 2021-05-23T14:36:04.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-01-24T09:41:55.000Z (over 4 years ago)
• Last Synced: 2024-05-30T14:49:29.418Z (about 2 years ago)
• Topics: api, client, python, server, websockets
• Language: Python
• Homepage:
• Size: 25.4 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


![GitHub](https://img.shields.io/github/license/Shadofer/basicpyapi) ![GitHub Repo stars](https://img.shields.io/github/stars/Shadofer/basicpyapi?style=social) ![GitHub forks](https://img.shields.io/github/forks/Shadofer/basicpyapi?style=social) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/Shadofer/basicpyapi) ![Lines of code](https://img.shields.io/tokei/lines/github/Shadofer/basicpyapi)

# A basic websocket API made in python

## What's the purpose of this project?

**Demonstrates the ```websockets``` package and shows how to create a server which responds to given data.**

**Provides client-side code in order to create an effective loop of data.**

**Both models are extensible and customisable.**

## Is this a production product?

**Of course not, it only contains barebone code which is meant to be optimised and tailored to your specific needs.**

## Are there any other websocket-relevant projects?

**For a complete server breakdown, check out [TowerVerse](https://github.com/TowerVerse/towerverseserver).**

**For a complete API breakdown, check out [Dogey](https://github.com/Shadofer/dogey).**

## Installation

**```pip install -r requirements.txt```**

**Tip: Rename ```env.example``` to ```.env``` in order to setup customised options for the server.**

## Running

**```python3 basicpyapi/api.py``` to start the websockets server.**

**```python3 basicpyapi/client.py``` to run a preconfigured client.**