diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-fortnite-api.spec | 903 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 905 insertions, 0 deletions
@@ -0,0 +1 @@ +/fortnite-api-2.5.4.tar.gz diff --git a/python-fortnite-api.spec b/python-fortnite-api.spec new file mode 100644 index 0000000..2cd00c2 --- /dev/null +++ b/python-fortnite-api.spec @@ -0,0 +1,903 @@ +%global _empty_manifest_terminate_build 0 +Name: python-fortnite-api +Version: 2.5.4 +Release: 1 +Summary: A python wrapper for Fortnite-API.com +License: MIT +URL: https://github.com/Fortnite-API/py-wrapper +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/63/c4/2b4b8a919bd31f6b2cf9479ca36b997aeda68c8fcb8e0e370bf0d56b8f89/fortnite-api-2.5.4.tar.gz +BuildArch: noarch + + +%description +# Sync/Async Python wrapper for [Fortnite-API.com](https://fortnite-api.com) + +[](https://pypi.org/project/fortnite-api) +[](https://pypi.org/project/fortnite-api) + +[](https://discord.gg/T4tyYDK) +<br><br> +This library offers a complete **sync** and **async** wrapper around the endpoints of [Fortnite-API.com](https://fortnite-api.com) + +## Installation +``` +pip install fortnite-api +``` +- Get a API key on https://dash.fortnite-api.com/account + +## Documentation +Here is a quick overview how to start.<br><br> +First we need to import the api and initialize client. +``` +import fortnite_api + +api = fortnite_api.FortniteAPI() +``` +###### Parameters +- `api_key` [str] (Optional) - Insert your API key from https://dash.fortnite-api.com/account +- `run_async` [bool] (Optional) - Specify if the API should run async. Default value is `False` +###### Attributes +- `cosmetics` - All cosmetic endpoints +- `shop` - All shop endpoints +- `news` - All news endpoints + +<br><br> +Now we can use the client: +### Cosmetics +``` +api.cosmetics.fetch_all() +``` +Get all Br cosmetics. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a list of `BrCosmetic` objects. + +``` +api.cosmetics.fetch_new() +``` +Get all new Br cosmetics. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `NewBrCosmetics` object. + +___ + +``` +api.cosmetics.search_by_id() +``` +Search one o multiple items by their id. +###### Parameters +- `*cosmetic_id` - One or multiple cosmetic ids. +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a list of `BrCosmetic` objects. + +___ + +``` +api.cosmetics.search_all() +``` +Search all cosmetics which fit to the search parameters +###### Parameters +- `**search_parameters` - All search parameters are listed on the [Fortnite-API.com Docs](https://fortnite-api.com/documentation). Remember that Python does not use a camel case. So e.g. `searchLanguage` becomes `search_language` +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a list of `BrCosmetic` objects. + +___ + +``` +api.cosmetics.search_first() +``` +Search the first cosmetics which fit to the search parameters +###### Parameters +- `**search_parameters` (Optional) - All search parameters are listed on the [Fortnite-API.com Docs](https://fortnite-api.com/documentation). Remember that Python does not use a camel case. So e.g. `searchLanguage` becomes `search_language` +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `BrCosmetic` objects. + +___ + +### Playlist +``` +api.playlists.fetch_all() +``` +Get all Br playlists. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the playlists. Default is set to english +###### Returns +Returns a list of `Playlist` objects. + +``` +api.cosmetics.fetch_by_id() +``` +Get a playlist by id. +###### Parameters +- `id` [str] - Specify the playlist id. +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `Playlist` object. + +___ + + +### Shop +``` +api.shop.fetch() +``` +Get the latest Fortnite shop. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +- `combined` [bool] (Optional) - Enable that `special_featured` and `special_daily` are moved into `featured` and `daily` +###### Returns +Returns a `Shop` object. + +___ + +### AES +``` +api.aes.fetch() +``` +Get the latest Fortnite AES Key. This also include version and build information. +###### Parameters +- `key_format` [KeyFormat] (Optional) - Specify the AES key format. Default is set to HEX +###### Returns +Returns a `AES` object. + +___ + +### News +``` +api.news.fetch() +``` +Get the latest Fortnite news of all game modes. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `News` object. + +___ + + +``` +api.news.fetch_by_type() +``` +Get the latest Fortnite news of a specified game mode. +###### Parameters +- `news_type` [NewsType] - Specify the news type. +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `GameModeNews` object. + +___ + +### Creator Code +``` +api.creator_code.fetch() +``` +Get information about a creator code. +###### Parameters +- `name` [str] - Specify a creator code. +###### Returns +Returns a `CreatorCode` object. + +___ + +``` +api.creator_code.exists() +``` +Check if a creator code exists. +###### Parameters +- `name` [str] - Specify a creator code. +###### Returns +Returns a `bool` object. + +___ + + +``` +api.creator_code.search_all() +``` +Search a creator code by name. All results are provided. +###### Parameters +- `name` [str] - Specify a creator code. +###### Returns +Returns a `list` of `CreatorCode` objects. + +___ + + +``` +api.creator_code.search_first() +``` +Search a creator code by name. Only the first result is provided. +###### Parameters +- `name` [str] - Specify a creator code. +###### Returns +Returns a `CreatorCode` object. + +___ + +### BR Stats +``` +api.stats.fetch_by_name() +``` +Returns stats of the requested player account. +###### Parameters +- `name` [str] - Sets the account name. +- `account_type` [AccountType] (Optional) - Sets the account type. +- `time_window` [TimeWindow] (Optional) - Sets the time window. +- `image` [StatsImageType] (Optional) - Sets the image platform. +###### Returns +Returns a `BrPlayerStats` object. + +___ + +``` +api.stats.fetch_by_id() +``` +Returns stats of the requested player account by its account id. +###### Parameters +- `account_id` [str] - Sets the account id. +- `time_window` [TimeWindow] (Optional) - Sets the time window. +- `image` [StatsImageType] (Optional) - Sets the image platform. +###### Returns +Returns a `BrPlayerStats` object. + +### Banner +``` +api.cosmetics.fetch() +``` +Get all banners. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the banners. Default is set to english +###### Returns +Returns a `Banner` object. + +___ + +``` +api.cosmetics.fetch_colors() +``` +Get all banner colors. +###### Returns +Returns a list of `BannerColor` objects. + + +### Map +``` +api.map.fetch() +``` +Get the current map information. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the map pois. Default is set to english. +###### Returns +Returns a `Map` object. + +___ + + + +## Contribute +Every type of contribution is appreciated! + +## License +- Fortnite-API Wrapper (MIT) [License](https://github.com/Fortnite-API/python-wrapper/blob/master/LICENSE) +- requests (Apache) [License](https://github.com/psf/requests/blob/master/LICENSE) +- aiohttp (Apache) [License](https://github.com/aio-libs/aiohttp/blob/6a5ab96bd9cb404b4abfd5160fe8f34a29d941e5/LICENSE.txt) + + +%package -n python3-fortnite-api +Summary: A python wrapper for Fortnite-API.com +Provides: python-fortnite-api +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-fortnite-api +# Sync/Async Python wrapper for [Fortnite-API.com](https://fortnite-api.com) + +[](https://pypi.org/project/fortnite-api) +[](https://pypi.org/project/fortnite-api) + +[](https://discord.gg/T4tyYDK) +<br><br> +This library offers a complete **sync** and **async** wrapper around the endpoints of [Fortnite-API.com](https://fortnite-api.com) + +## Installation +``` +pip install fortnite-api +``` +- Get a API key on https://dash.fortnite-api.com/account + +## Documentation +Here is a quick overview how to start.<br><br> +First we need to import the api and initialize client. +``` +import fortnite_api + +api = fortnite_api.FortniteAPI() +``` +###### Parameters +- `api_key` [str] (Optional) - Insert your API key from https://dash.fortnite-api.com/account +- `run_async` [bool] (Optional) - Specify if the API should run async. Default value is `False` +###### Attributes +- `cosmetics` - All cosmetic endpoints +- `shop` - All shop endpoints +- `news` - All news endpoints + +<br><br> +Now we can use the client: +### Cosmetics +``` +api.cosmetics.fetch_all() +``` +Get all Br cosmetics. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a list of `BrCosmetic` objects. + +``` +api.cosmetics.fetch_new() +``` +Get all new Br cosmetics. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `NewBrCosmetics` object. + +___ + +``` +api.cosmetics.search_by_id() +``` +Search one o multiple items by their id. +###### Parameters +- `*cosmetic_id` - One or multiple cosmetic ids. +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a list of `BrCosmetic` objects. + +___ + +``` +api.cosmetics.search_all() +``` +Search all cosmetics which fit to the search parameters +###### Parameters +- `**search_parameters` - All search parameters are listed on the [Fortnite-API.com Docs](https://fortnite-api.com/documentation). Remember that Python does not use a camel case. So e.g. `searchLanguage` becomes `search_language` +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a list of `BrCosmetic` objects. + +___ + +``` +api.cosmetics.search_first() +``` +Search the first cosmetics which fit to the search parameters +###### Parameters +- `**search_parameters` (Optional) - All search parameters are listed on the [Fortnite-API.com Docs](https://fortnite-api.com/documentation). Remember that Python does not use a camel case. So e.g. `searchLanguage` becomes `search_language` +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `BrCosmetic` objects. + +___ + +### Playlist +``` +api.playlists.fetch_all() +``` +Get all Br playlists. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the playlists. Default is set to english +###### Returns +Returns a list of `Playlist` objects. + +``` +api.cosmetics.fetch_by_id() +``` +Get a playlist by id. +###### Parameters +- `id` [str] - Specify the playlist id. +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `Playlist` object. + +___ + + +### Shop +``` +api.shop.fetch() +``` +Get the latest Fortnite shop. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +- `combined` [bool] (Optional) - Enable that `special_featured` and `special_daily` are moved into `featured` and `daily` +###### Returns +Returns a `Shop` object. + +___ + +### AES +``` +api.aes.fetch() +``` +Get the latest Fortnite AES Key. This also include version and build information. +###### Parameters +- `key_format` [KeyFormat] (Optional) - Specify the AES key format. Default is set to HEX +###### Returns +Returns a `AES` object. + +___ + +### News +``` +api.news.fetch() +``` +Get the latest Fortnite news of all game modes. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `News` object. + +___ + + +``` +api.news.fetch_by_type() +``` +Get the latest Fortnite news of a specified game mode. +###### Parameters +- `news_type` [NewsType] - Specify the news type. +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `GameModeNews` object. + +___ + +### Creator Code +``` +api.creator_code.fetch() +``` +Get information about a creator code. +###### Parameters +- `name` [str] - Specify a creator code. +###### Returns +Returns a `CreatorCode` object. + +___ + +``` +api.creator_code.exists() +``` +Check if a creator code exists. +###### Parameters +- `name` [str] - Specify a creator code. +###### Returns +Returns a `bool` object. + +___ + + +``` +api.creator_code.search_all() +``` +Search a creator code by name. All results are provided. +###### Parameters +- `name` [str] - Specify a creator code. +###### Returns +Returns a `list` of `CreatorCode` objects. + +___ + + +``` +api.creator_code.search_first() +``` +Search a creator code by name. Only the first result is provided. +###### Parameters +- `name` [str] - Specify a creator code. +###### Returns +Returns a `CreatorCode` object. + +___ + +### BR Stats +``` +api.stats.fetch_by_name() +``` +Returns stats of the requested player account. +###### Parameters +- `name` [str] - Sets the account name. +- `account_type` [AccountType] (Optional) - Sets the account type. +- `time_window` [TimeWindow] (Optional) - Sets the time window. +- `image` [StatsImageType] (Optional) - Sets the image platform. +###### Returns +Returns a `BrPlayerStats` object. + +___ + +``` +api.stats.fetch_by_id() +``` +Returns stats of the requested player account by its account id. +###### Parameters +- `account_id` [str] - Sets the account id. +- `time_window` [TimeWindow] (Optional) - Sets the time window. +- `image` [StatsImageType] (Optional) - Sets the image platform. +###### Returns +Returns a `BrPlayerStats` object. + +### Banner +``` +api.cosmetics.fetch() +``` +Get all banners. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the banners. Default is set to english +###### Returns +Returns a `Banner` object. + +___ + +``` +api.cosmetics.fetch_colors() +``` +Get all banner colors. +###### Returns +Returns a list of `BannerColor` objects. + + +### Map +``` +api.map.fetch() +``` +Get the current map information. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the map pois. Default is set to english. +###### Returns +Returns a `Map` object. + +___ + + + +## Contribute +Every type of contribution is appreciated! + +## License +- Fortnite-API Wrapper (MIT) [License](https://github.com/Fortnite-API/python-wrapper/blob/master/LICENSE) +- requests (Apache) [License](https://github.com/psf/requests/blob/master/LICENSE) +- aiohttp (Apache) [License](https://github.com/aio-libs/aiohttp/blob/6a5ab96bd9cb404b4abfd5160fe8f34a29d941e5/LICENSE.txt) + + +%package help +Summary: Development documents and examples for fortnite-api +Provides: python3-fortnite-api-doc +%description help +# Sync/Async Python wrapper for [Fortnite-API.com](https://fortnite-api.com) + +[](https://pypi.org/project/fortnite-api) +[](https://pypi.org/project/fortnite-api) + +[](https://discord.gg/T4tyYDK) +<br><br> +This library offers a complete **sync** and **async** wrapper around the endpoints of [Fortnite-API.com](https://fortnite-api.com) + +## Installation +``` +pip install fortnite-api +``` +- Get a API key on https://dash.fortnite-api.com/account + +## Documentation +Here is a quick overview how to start.<br><br> +First we need to import the api and initialize client. +``` +import fortnite_api + +api = fortnite_api.FortniteAPI() +``` +###### Parameters +- `api_key` [str] (Optional) - Insert your API key from https://dash.fortnite-api.com/account +- `run_async` [bool] (Optional) - Specify if the API should run async. Default value is `False` +###### Attributes +- `cosmetics` - All cosmetic endpoints +- `shop` - All shop endpoints +- `news` - All news endpoints + +<br><br> +Now we can use the client: +### Cosmetics +``` +api.cosmetics.fetch_all() +``` +Get all Br cosmetics. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a list of `BrCosmetic` objects. + +``` +api.cosmetics.fetch_new() +``` +Get all new Br cosmetics. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `NewBrCosmetics` object. + +___ + +``` +api.cosmetics.search_by_id() +``` +Search one o multiple items by their id. +###### Parameters +- `*cosmetic_id` - One or multiple cosmetic ids. +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a list of `BrCosmetic` objects. + +___ + +``` +api.cosmetics.search_all() +``` +Search all cosmetics which fit to the search parameters +###### Parameters +- `**search_parameters` - All search parameters are listed on the [Fortnite-API.com Docs](https://fortnite-api.com/documentation). Remember that Python does not use a camel case. So e.g. `searchLanguage` becomes `search_language` +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a list of `BrCosmetic` objects. + +___ + +``` +api.cosmetics.search_first() +``` +Search the first cosmetics which fit to the search parameters +###### Parameters +- `**search_parameters` (Optional) - All search parameters are listed on the [Fortnite-API.com Docs](https://fortnite-api.com/documentation). Remember that Python does not use a camel case. So e.g. `searchLanguage` becomes `search_language` +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `BrCosmetic` objects. + +___ + +### Playlist +``` +api.playlists.fetch_all() +``` +Get all Br playlists. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the playlists. Default is set to english +###### Returns +Returns a list of `Playlist` objects. + +``` +api.cosmetics.fetch_by_id() +``` +Get a playlist by id. +###### Parameters +- `id` [str] - Specify the playlist id. +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `Playlist` object. + +___ + + +### Shop +``` +api.shop.fetch() +``` +Get the latest Fortnite shop. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +- `combined` [bool] (Optional) - Enable that `special_featured` and `special_daily` are moved into `featured` and `daily` +###### Returns +Returns a `Shop` object. + +___ + +### AES +``` +api.aes.fetch() +``` +Get the latest Fortnite AES Key. This also include version and build information. +###### Parameters +- `key_format` [KeyFormat] (Optional) - Specify the AES key format. Default is set to HEX +###### Returns +Returns a `AES` object. + +___ + +### News +``` +api.news.fetch() +``` +Get the latest Fortnite news of all game modes. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `News` object. + +___ + + +``` +api.news.fetch_by_type() +``` +Get the latest Fortnite news of a specified game mode. +###### Parameters +- `news_type` [NewsType] - Specify the news type. +- `language` [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english +###### Returns +Returns a `GameModeNews` object. + +___ + +### Creator Code +``` +api.creator_code.fetch() +``` +Get information about a creator code. +###### Parameters +- `name` [str] - Specify a creator code. +###### Returns +Returns a `CreatorCode` object. + +___ + +``` +api.creator_code.exists() +``` +Check if a creator code exists. +###### Parameters +- `name` [str] - Specify a creator code. +###### Returns +Returns a `bool` object. + +___ + + +``` +api.creator_code.search_all() +``` +Search a creator code by name. All results are provided. +###### Parameters +- `name` [str] - Specify a creator code. +###### Returns +Returns a `list` of `CreatorCode` objects. + +___ + + +``` +api.creator_code.search_first() +``` +Search a creator code by name. Only the first result is provided. +###### Parameters +- `name` [str] - Specify a creator code. +###### Returns +Returns a `CreatorCode` object. + +___ + +### BR Stats +``` +api.stats.fetch_by_name() +``` +Returns stats of the requested player account. +###### Parameters +- `name` [str] - Sets the account name. +- `account_type` [AccountType] (Optional) - Sets the account type. +- `time_window` [TimeWindow] (Optional) - Sets the time window. +- `image` [StatsImageType] (Optional) - Sets the image platform. +###### Returns +Returns a `BrPlayerStats` object. + +___ + +``` +api.stats.fetch_by_id() +``` +Returns stats of the requested player account by its account id. +###### Parameters +- `account_id` [str] - Sets the account id. +- `time_window` [TimeWindow] (Optional) - Sets the time window. +- `image` [StatsImageType] (Optional) - Sets the image platform. +###### Returns +Returns a `BrPlayerStats` object. + +### Banner +``` +api.cosmetics.fetch() +``` +Get all banners. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the banners. Default is set to english +###### Returns +Returns a `Banner` object. + +___ + +``` +api.cosmetics.fetch_colors() +``` +Get all banner colors. +###### Returns +Returns a list of `BannerColor` objects. + + +### Map +``` +api.map.fetch() +``` +Get the current map information. +###### Parameters +- `language` [GameLanguage] (Optional) - Specify the language of the map pois. Default is set to english. +###### Returns +Returns a `Map` object. + +___ + + + +## Contribute +Every type of contribution is appreciated! + +## License +- Fortnite-API Wrapper (MIT) [License](https://github.com/Fortnite-API/python-wrapper/blob/master/LICENSE) +- requests (Apache) [License](https://github.com/psf/requests/blob/master/LICENSE) +- aiohttp (Apache) [License](https://github.com/aio-libs/aiohttp/blob/6a5ab96bd9cb404b4abfd5160fe8f34a29d941e5/LICENSE.txt) + + +%prep +%autosetup -n fortnite-api-2.5.4 + +%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-fortnite-api -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 15 2023 Python_Bot <Python_Bot@openeuler.org> - 2.5.4-1 +- Package Spec generated @@ -0,0 +1 @@ +954c6616be90859149cb27f8d0d9152e fortnite-api-2.5.4.tar.gz |