diff options
Diffstat (limited to 'python-xboxapi.spec')
| -rw-r--r-- | python-xboxapi.spec | 238 |
1 files changed, 238 insertions, 0 deletions
diff --git a/python-xboxapi.spec b/python-xboxapi.spec new file mode 100644 index 0000000..b1cd9a5 --- /dev/null +++ b/python-xboxapi.spec @@ -0,0 +1,238 @@ +%global _empty_manifest_terminate_build 0 +Name: python-xboxapi +Version: 2.0.1 +Release: 1 +Summary: XBOX One API +License: MIT License +URL: https://github.com/mKeRix/xboxapi-python +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/68/72/a5f198e1f9c9f73b2058b25eed965418140ca427d636a2513603b574e934/xboxapi-2.0.1.tar.gz +BuildArch: noarch + +Requires: python3-requests + +%description +# Description # + +This is a Python wrapper for the unofficial [Xbox API](https://xboxapi.com) + +[](https://travis-ci.org/xboxapi/Python-Wrapper) + +# Installation # +For now you will have to install manually, as I didn't upload the initial version to pypi (`pip`). + +1. Clone this repo +2. Place the `xboxapi` directory in your project + +The only dependency is [requests](https://github.com/kennethreitz/requests) library. + +# Usage # + +This is a basic example of how to create a client and fetch a gamers profile information from their gamertag. + +```python +from xboxapi import Client + +client = Client(api_key=<api_key>) +gamer = client.gamer('voidpirate') + +profile = gamer.get('profile') +``` + +`Client` class constructor takes the following optional arguments except `api_key`. + +| Argument | Value | Short Description | +|--- |--- |--- | +| api_key | string | api token from [Xbox API](https://xboxapi.com) | +| timeout | int | how long until the request times out (seconds) | +| lang | string | country language code (e.g. for German (`de-DE`)) | + + +`Client` class public methods. + +| Method | Value | Optional | Short Description | +|--- |--- |--- |--- | +| `gamer(gamertag=<string>)` | string | `xuid=<string>` | gamertag to lookup | +| `calls_remaining()` | n/a | n/a | Return headers about api rate limits | + +A note about the gamer method. If you already know the gamers xuid you can use that instead to avoid an additional api call when using only a gamertag. + +`Gamer` class public methods, returned from gamer method in `Client`. + +| Method | Value | Optional | Short Description | +|--- |--- |--- |--- | +| `get(method=<string>)` | string | `term=<string>` | API calls. | +| `send_message(message=<string>)` | string | n/a | Send a message to gamer | +| `send_activity(message=<string>)` | string | n/a | Update your activity feed with a message | + +Pagination is supported in this client and all handled through `get` method. It works by detecting the response header for pagination, any subsequent calls to the same api endpoint will return paged data. If another api call is made to a different endpoint, the pagination token will be cleared and results will not be paged. + + + +%package -n python3-xboxapi +Summary: XBOX One API +Provides: python-xboxapi +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-xboxapi +# Description # + +This is a Python wrapper for the unofficial [Xbox API](https://xboxapi.com) + +[](https://travis-ci.org/xboxapi/Python-Wrapper) + +# Installation # +For now you will have to install manually, as I didn't upload the initial version to pypi (`pip`). + +1. Clone this repo +2. Place the `xboxapi` directory in your project + +The only dependency is [requests](https://github.com/kennethreitz/requests) library. + +# Usage # + +This is a basic example of how to create a client and fetch a gamers profile information from their gamertag. + +```python +from xboxapi import Client + +client = Client(api_key=<api_key>) +gamer = client.gamer('voidpirate') + +profile = gamer.get('profile') +``` + +`Client` class constructor takes the following optional arguments except `api_key`. + +| Argument | Value | Short Description | +|--- |--- |--- | +| api_key | string | api token from [Xbox API](https://xboxapi.com) | +| timeout | int | how long until the request times out (seconds) | +| lang | string | country language code (e.g. for German (`de-DE`)) | + + +`Client` class public methods. + +| Method | Value | Optional | Short Description | +|--- |--- |--- |--- | +| `gamer(gamertag=<string>)` | string | `xuid=<string>` | gamertag to lookup | +| `calls_remaining()` | n/a | n/a | Return headers about api rate limits | + +A note about the gamer method. If you already know the gamers xuid you can use that instead to avoid an additional api call when using only a gamertag. + +`Gamer` class public methods, returned from gamer method in `Client`. + +| Method | Value | Optional | Short Description | +|--- |--- |--- |--- | +| `get(method=<string>)` | string | `term=<string>` | API calls. | +| `send_message(message=<string>)` | string | n/a | Send a message to gamer | +| `send_activity(message=<string>)` | string | n/a | Update your activity feed with a message | + +Pagination is supported in this client and all handled through `get` method. It works by detecting the response header for pagination, any subsequent calls to the same api endpoint will return paged data. If another api call is made to a different endpoint, the pagination token will be cleared and results will not be paged. + + + +%package help +Summary: Development documents and examples for xboxapi +Provides: python3-xboxapi-doc +%description help +# Description # + +This is a Python wrapper for the unofficial [Xbox API](https://xboxapi.com) + +[](https://travis-ci.org/xboxapi/Python-Wrapper) + +# Installation # +For now you will have to install manually, as I didn't upload the initial version to pypi (`pip`). + +1. Clone this repo +2. Place the `xboxapi` directory in your project + +The only dependency is [requests](https://github.com/kennethreitz/requests) library. + +# Usage # + +This is a basic example of how to create a client and fetch a gamers profile information from their gamertag. + +```python +from xboxapi import Client + +client = Client(api_key=<api_key>) +gamer = client.gamer('voidpirate') + +profile = gamer.get('profile') +``` + +`Client` class constructor takes the following optional arguments except `api_key`. + +| Argument | Value | Short Description | +|--- |--- |--- | +| api_key | string | api token from [Xbox API](https://xboxapi.com) | +| timeout | int | how long until the request times out (seconds) | +| lang | string | country language code (e.g. for German (`de-DE`)) | + + +`Client` class public methods. + +| Method | Value | Optional | Short Description | +|--- |--- |--- |--- | +| `gamer(gamertag=<string>)` | string | `xuid=<string>` | gamertag to lookup | +| `calls_remaining()` | n/a | n/a | Return headers about api rate limits | + +A note about the gamer method. If you already know the gamers xuid you can use that instead to avoid an additional api call when using only a gamertag. + +`Gamer` class public methods, returned from gamer method in `Client`. + +| Method | Value | Optional | Short Description | +|--- |--- |--- |--- | +| `get(method=<string>)` | string | `term=<string>` | API calls. | +| `send_message(message=<string>)` | string | n/a | Send a message to gamer | +| `send_activity(message=<string>)` | string | n/a | Update your activity feed with a message | + +Pagination is supported in this client and all handled through `get` method. It works by detecting the response header for pagination, any subsequent calls to the same api endpoint will return paged data. If another api call is made to a different endpoint, the pagination token will be cleared and results will not be paged. + + + +%prep +%autosetup -n xboxapi-2.0.1 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-xboxapi -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Thu Mar 09 2023 Python_Bot <Python_Bot@openeuler.org> - 2.0.1-1 +- Package Spec generated |