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 60ebd9d commit 93d37c3
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 19 deletions.
5 changes: 2 additions & 3 deletions .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@ on:
jobs:
build:

# Use ubuntu-20.04 since ubuntu-22.04 doesn't support python 3.6
runs-on: ubuntu-20.04
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: [3.6, 3.7, 3.8, 3.9, '3.10', 3.11]
python-version: [3.7, 3.8, 3.9, '3.10', 3.11]

steps:
- uses: actions/checkout@v3
Expand Down
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ from opengsq.protocols import (

## Requirements

- Python 3.6 or higher
- Python 3.7 or higher

## Installation

Expand All @@ -53,12 +53,6 @@ The recommended installation method is using [pip](http://pip-installer.org/):
pip install --upgrade opengsq
```

or, install from source manually with:

```sh
python setup.py install
```

## Usage

Here’s an example of how to query a server using the Source protocol:
Expand Down
11 changes: 5 additions & 6 deletions docs/install.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
Installation
============

You can install the OpenGSQ library using pip:

.. code-block:: console
Requirements
------------

(.venv) $ pip install --upgrade opengsq
- Python 3.7 or higher

Alternatively, you can install from source manually:
You can install the OpenGSQ library using pip:

.. code-block:: console
(.venv) $ python setup.py install
(.venv) $ pip install --upgrade opengsq
2 changes: 1 addition & 1 deletion opengsq/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '2.3.1'
__version__ = '3.0.0'
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[build-system]
requires = ["setuptools", "wheel"]
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
install_requires=install_requires,
entry_points={'console_scripts': ['opengsq=opengsq.cli:main']},
packages=find_packages(exclude=['tests', 'tests.*']),
python_requires='>=3.6',
python_requires='>=3.7',
url='https://github.com/opengsq/opengsq-python',
project_urls={
'Bug Tracker': 'https://github.com/opengsq/opengsq-python/issues',
Expand All @@ -41,7 +41,6 @@
'License :: OSI Approved :: MIT License',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
Expand Down

0 comments on commit 93d37c3

Please sign in to comment.