From fd6f7cb4ca16405c6fe465f9a1e377fb109a3d22 Mon Sep 17 00:00:00 2001 From: DarkCat09 Date: Fri, 13 May 2022 18:05:23 +0400 Subject: [PATCH] Readme and setup.py changes --- README.md | 17 ++++++++++++----- setup.py | 16 +++++++++++++--- 2 files changed, 25 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7dcfc20..5f0531f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ An unofficial Aternos API written in Python. It uses [aternos](https://aternos.org/)' private API and html parsing. +> Note: +Now, the main repository is located on [Codeberg](https://codeberg.org/DarkCat09/python-aternos) because GitHub bans its Russian users. +I'm still updating the GH repository together with the Codeberg one. + ## Installing ```bash pip install python-aternos @@ -26,6 +30,8 @@ from python_aternos import Client aternos = Client.from_credentials('example', 'test123') # ----OR---- aternos = Client.from_hashed('example', 'cc03e747a6afbbcbf8be7668acfebee5') +# ----OR---- +aternos = Client.restore_session() # Returns AternosServer list servs = aternos.list_servers() @@ -50,9 +56,9 @@ if testserv != None: # Starts server testserv.start() ``` -~~You can find full documentation on the [Project Wiki](https://github.com/DarkCat09/python-aternos/wiki).~~ +The documentation have not made yet. View examples and ask in the issues. -## [More examples](/examples) +## [More examples](https://codeberg.org/DarkCat09/python-aternos/src/branch/main/examples) / [on GitHub](https://github.com/DarkCat09/python-aternos/tree/main/examples) ## Changelog |Version|Description| @@ -63,9 +69,10 @@ if testserv != None: |v0.4|Implemented configuration API, some bugfixes.| |v0.5|The API was updated corresponding to new Aternos security methods. Huge thanks to [lusm554](https://github.com/lusm554).| |v0.6/v1.0.0|Code refactoring, websockets API and session saving to prevent detecting automation access.| -|v1.0.1|Cloudflare bypassing fix, changed versioning (follows SemVer).| -|v1.1.x|Full implementation of config and software API, unit tests and documentation is planned.| -|v1.2.x|Shared access API and Google Drive backups is planned.| +|v1.0.x|Lots of bugfixes, changed versioning (SemVer).| +|v1.1.x|Switching to selenium with [a custom Chrome driver](https://github.com/ultrafunkamsterdam/undetected-chromedriver), writing API documentation.| +|v1.2.x|Full implementation of config and software API, unit tests and documentation is planned.| +|v1.3.x|Shared access API and Google Drive backups is planned.| ## License [License Notice](NOTICE): diff --git a/setup.py b/setup.py index 8b4b3a4..e9bba4e 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ with open('README.md', 'rt') as readme: setuptools.setup( name='python-aternos', - version='1.0.1', + version='1.0.2', author='Chechkenev Andrey (@DarkCat09)', author_email='aacd0709@mail.ru', description='An unofficial Aternos API', @@ -13,14 +13,24 @@ setuptools.setup( long_description_content_type='text/markdown', url='https://github.com/DarkCat09/python-aternos', project_urls={ + 'Homepage': 'https://codeberg.org/DarkCat09/python-aternos', + 'GitHub': 'https://github.com/DarkCat09/python-aternos', 'Bug Tracker': 'https://github.com/DarkCat09/python-aternos/issues', - 'Alternative Repo': 'https://codeberg.org/DarkCat09/python-aternos' + 'Bug Tracker 2': 'https://codeberg.org/DarkCat09/python-aternos/issues' }, classifiers=[ 'Development Status :: 4 - Beta', 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Programming Language :: Python :: 3.10', 'License :: OSI Approved :: Apache Software License', - 'Operating System :: OS Independent' + 'Operating System :: OS Independent', + 'Operating System :: Microsoft :: Windows', + 'Operating System :: POSIX :: Linux', + 'Operating System :: MacOS', + 'Operating System :: Other OS' ], install_requires=[ 'lxml>=4.8.0',