Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Datenlord1510/PYxREL
A Python API wrapper for the official xREL API.
https://github.com/Datenlord1510/PYxREL
Last synced: about 2 months ago
JSON representation
A Python API wrapper for the official xREL API.
- Host: GitHub
- URL: https://github.com/Datenlord1510/PYxREL
- Owner: Datenlord1510
- License: mit
- Created: 2023-09-14T18:55:26.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-16T12:01:01.000Z (4 months ago)
- Last Synced: 2024-06-09T19:32:00.642Z (4 months ago)
- Language: Python
- Homepage: https://www.xrel.to/
- Size: 19.5 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PYxREL
This is a Python API wrapper for the official xREL API, providing an easy way to access xREL's service and data.
## Usage
You can use this package by importing the `xREL` class directly into your Python scripts. Here's how to do it:
```Python
from pyxrel import xREL
# Create an instance of the xREL class
xrel = xREL()
# Use the xREL API methods
result = xrel.SomeClass.some_method()
```
*SomeClass* should be replaced by *Search*, *P2P*, *ExtInfo* or any other class the xREL API offers methods for.
Please note that currently the OAuth authentication is not implemented. However, all other methods that do not require authentication are available for use. Feel free to make a pull request!
## Documentation
For further information on the implemented methods please have a look at the [official xREL-API documentation](https://www.xrel.to/wiki/1681/API.html).