Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BattlefieldDuck committed Jan 26, 2024
1 parent 6679f26 commit 9ecef69
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 33 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: [3.7, 3.8, 3.9, '3.10', 3.11]
python-version: [3.6, 3.7, 3.8, 3.9, '3.10', 3.11]

steps:
- uses: actions/checkout@v3
Expand Down
60 changes: 31 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,48 @@

[![Python Package](https://github.com/opengsq/opengsq-python/actions/workflows/python-package.yml/badge.svg)](https://github.com/opengsq/opengsq-python/actions/workflows/python-package.yml)
[![GitHub license](https://img.shields.io/github/license/opengsq/opengsq-python)](https://github.com/opengsq/opengsq-python/blob/main/LICENSE)
[![](https://img.shields.io/pypi/v/opengsq.svg)](https://pypi.org/project/opengsq/)
[![](https://img.shields.io/pypi/pyversions/opengsq.svg)](https://pypi.org/project/opengsq/)
[![PyPI version](https://img.shields.io/pypi/v/opengsq.svg)](https://pypi.org/project/opengsq/)
[![Python versions](https://img.shields.io/pypi/pyversions/opengsq.svg)](https://pypi.org/project/opengsq/)
[![Downloads](https://pepy.tech/badge/opengsq)](https://pepy.tech/project/opengsq)

The OpenGSQ Python library provides a convenient way to query servers
from applications written in the Python language.

## Supported Protocols

The library supports a wide range of protocols. Here are some examples:

```py
from opengsq.protocols.ase import ASE
from opengsq.protocols.battlefield import Battlefield
from opengsq.protocols.doom3 import Doom3
from opengsq.protocols.eos import EOS
from opengsq.protocols.fivem import FiveM
from opengsq.protocols.gamespy1 import GameSpy1
from opengsq.protocols.gamespy2 import GameSpy2
from opengsq.protocols.gamespy3 import GameSpy3
from opengsq.protocols.gamespy4 import GameSpy4
from opengsq.protocols.killingfloor import KillingFloor
from opengsq.protocols.minecraft import Minecraft
from opengsq.protocols.quake1 import Quake1
from opengsq.protocols.quake2 import Quake2
from opengsq.protocols.quake3 import Quake3
from opengsq.protocols.raknet import RakNet
from opengsq.protocols.samp import Samp
from opengsq.protocols.satisfactory import Satisfactory
from opengsq.protocols.scum import Scum
from opengsq.protocols.source import Source
from opengsq.protocols.teamspeak3 import TeamSpeak3
from opengsq.protocols.unreal2 import Unreal2
from opengsq.protocols.vcmp import Vcmp
from opengsq.protocols.won import WON
from opengsq.protocols import (
ASE,
Battlefield,
Doom3,
EOS,
FiveM,
GameSpy1,
GameSpy2,
GameSpy3,
GameSpy4,
KillingFloor,
Minecraft,
Quake1,
Quake2,
Quake3,
RakNet,
Samp,
Satisfactory,
Scum,
Source,
TeamSpeak3,
Unreal2,
Vcmp,
WON,
)
```

## Requirements

- Python 3.6+
- Python 3.6 or higher

## Installation

Expand Down Expand Up @@ -104,6 +108,4 @@ opengsq source --host 123.123.123.123 --port 27015 --function get_info

## Tests and Results

See [tests/protocols](/tests/protocols) for the tests.

See [tests/results](/tests/results) for tests outputs.
You can find information about tests and results at [https://python.opengsq.com/tests/protocols](https://python.opengsq.com/tests/protocols)
2 changes: 1 addition & 1 deletion docs/tests/protocols/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _tests:
.. _protocols_tests:

Protocols Tests
===============
Expand Down
2 changes: 1 addition & 1 deletion docs/tests/rcon_protocols/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _tests:
.. _rcon_protocols_tests:

Rcon Protocols Tests
====================
Expand Down
2 changes: 1 addition & 1 deletion tests/result_handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ def create_tests_index_rst(self):
os.path.join(self.results_path, "index.rst"), "w", encoding="utf-8"
) as f:
title = self.last_dir.title().replace("_", " ") + ' Tests'
f.write(".. _tests:\n")
f.write(f".. _{self.last_dir}_tests:\n")
f.write(f"\n{title}\n")
f.write(f'{"=" * len(title)}\n')
f.write("\n.. toctree::\n")
Expand Down

0 comments on commit 9ecef69

Please sign in to comment.