mirror of
https://github.com/yawaflua/Py-SPW.git
synced 2025-12-10 04:19:31 +02:00
docs prettify
This commit is contained in:
18
README.md
18
README.md
@@ -1,14 +1,16 @@
|
|||||||
|
[](https://pyspw.xstl.ru/ru/latest/?badge=latest)
|
||||||
|
|
||||||
# Py SPW
|
# Py SPW
|
||||||
Library for work with [SPWorlds](https://spworlds.ru) API in Python.
|
Library for work with [SPWorlds](https://spworlds.ru) API in Python.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
Need python version >=3.7
|
**You need python >=3.7**
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
pip install Py-Spw
|
pip install Py-SPW
|
||||||
```
|
```
|
||||||
|
|
||||||
## Quick start
|
## Getting example
|
||||||
*Checking user access*
|
*Checking user access*
|
||||||
```python
|
```python
|
||||||
import pyspw
|
import pyspw
|
||||||
@@ -19,10 +21,14 @@ api = pyspw.SpApi(card_id='card_id',
|
|||||||
print(api.check_access('437610383310716930'))
|
print(api.check_access('437610383310716930'))
|
||||||
```
|
```
|
||||||
|
|
||||||
### How to
|
## Ask help
|
||||||
You can see [examples](https://github.com/teleportx/Py-SPW/tree/main/examples) to help solve your problem
|
|
||||||
|
* See the code [examples](https://github.com/teleportx/Py-SPW/tree/main/examples)
|
||||||
|
* If you found a bug in a library report it to [issue tracker](https://github.com/teleportx/Py-SPW/issues)
|
||||||
|
* Get help with your code using Py-SPW [discussions](https://github.com/teleportx/Py-SPW/discussions)
|
||||||
|
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
- [PyPi](https://pypi.org/project/Py-SPW)
|
- [PyPi](https://pypi.org/project/Py-SPW)
|
||||||
- [Documentation](https://github.com/teleportx/Py-SPW/wiki)
|
- [Documentation](https://pyspw.xstl.ru/latest)
|
||||||
- [API](https://github.com/sp-worlds/api-docs)
|
- [API](https://github.com/sp-worlds/api-docs)
|
||||||
@@ -39,7 +39,6 @@ html_sidebars = {
|
|||||||
"sidebar/brand.html",
|
"sidebar/brand.html",
|
||||||
"sidebar/search.html",
|
"sidebar/search.html",
|
||||||
"sidebar/navigation.html",
|
"sidebar/navigation.html",
|
||||||
"sidebar/navigation.html",
|
|
||||||
"sidebar/ethical-ads.html",
|
"sidebar/ethical-ads.html",
|
||||||
"sidebar/scroll-end.html",
|
"sidebar/scroll-end.html",
|
||||||
],
|
],
|
||||||
|
|||||||
@@ -5,12 +5,22 @@ Py-SPW Documentation
|
|||||||
|
|
||||||
Library for work with `SPWorlds <https://spworlds.ru>`_ API in Python.
|
Library for work with `SPWorlds <https://spworlds.ru>`_ API in Python.
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
**You need python >=3.7**
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
|
||||||
|
pip install Py-SPW
|
||||||
|
|
||||||
Getting example
|
Getting example
|
||||||
===============
|
===============
|
||||||
|
*Checking user access*
|
||||||
|
|
||||||
.. literalinclude:: ../../examples/check_access.py
|
.. literalinclude:: ../../examples/check_access.py
|
||||||
|
|
||||||
Ask help
|
Ask help
|
||||||
=============
|
========
|
||||||
|
|
||||||
* See the code `examples <https://github.com/teleportx/Py-SPW/tree/main/examples>`_
|
* See the code `examples <https://github.com/teleportx/Py-SPW/tree/main/examples>`_
|
||||||
* If you found a bug in a library report it to `issue tracker <https://github.com/teleportx/Py-SPW/issues>`_
|
* If you found a bug in a library report it to `issue tracker <https://github.com/teleportx/Py-SPW/issues>`_
|
||||||
|
|||||||
4
setup.py
4
setup.py
@@ -24,7 +24,7 @@ setup(
|
|||||||
install_requires=requirements,
|
install_requires=requirements,
|
||||||
python_requires='>=3.7',
|
python_requires='>=3.7',
|
||||||
project_urls={
|
project_urls={
|
||||||
"Docs": "https://github.com/teleport2/Py-SPW/wiki",
|
"Docs": "https://pyspw.xstl.ru/en/latest/",
|
||||||
"GitHub": "https://github.com/teleport2/Py-SPW"
|
"GitHub": "https://github.com/teleport2/Py-SPW/"
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in New Issue
Block a user