diff options
Diffstat (limited to 'python-pywaclient.spec')
| -rw-r--r-- | python-pywaclient.spec | 226 |
1 files changed, 226 insertions, 0 deletions
diff --git a/python-pywaclient.spec b/python-pywaclient.spec new file mode 100644 index 0000000..469ca81 --- /dev/null +++ b/python-pywaclient.spec @@ -0,0 +1,226 @@ +%global _empty_manifest_terminate_build 0 +Name: python-pywaclient +Version: 1.3.4 +Release: 1 +Summary: A small wrapper library around the World Anvil Aragorn API: https://www.worldanvil.com/api/aragorn/documentation. +License: Apache 2.0 +URL: https://gitlab.com/SoulLink/world-anvil-api-client +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/a7/1a/9b0a41784e24bd0a46c4a8e16d2ab5894171fa985bd69dc9aaa44b0e3c67/pywaclient-1.3.4.tar.gz +BuildArch: noarch + +Requires: python3-requests + +%description +# World Anvil API Python Client [WIP] + +I am currently in the process of adapting the library to the next +version of the API. This next version is not public yet. If you wish to +get access please message the team to discuss it. + +The latest version which works with Aragorn is `0.12.1`. Use the +highest tag to work with Boromir. + +The World Anvil API provides endpoints to interact with the World Anvil database. + +[Aragorn API Documentation](https://www.worldanvil.com/api/aragorn/documentation) +## Installation +The package is published on PYPI and can be installed with pip. + +`pip --install pywaclient` + +## Usage +This is a simple example on how to use the endpoints. + +```python +import os +from pywaclient.api import BoromirApiClient + +client = BoromirApiClient( + '<YourScriptName>', + '<link-to-your-website-or-bot-repository>', '<version>', os.environ['WA_APPLICATION_KEY'], + os.environ['WA_AUTH_TOKEN'] +) + +# get your own user id. It is not possible to discover the user ids of other users via the API. +authenticated_user = client.user.identity() + +# get the references to all the worlds on your account. +worlds = [world for world in client.user.worlds(authenticated_user['id'])] + +# get the references to all the category on the first world. +categories = [category for category in client.world.categories(worlds[0]['id'])] + +# gets a list of all the articles without a category in the first world +articles = [article for article in client.category.articles(worlds[0]['id'], '-1')] + +# gets the full content of the first article +article = client.article.get(articles[0]['id'], 2) + +# gets the full content of the first category. Categories and most other resources do not have a granularity of 2. +category = client.category.get(categories[0]['id'], 1) +``` + + + + + +%package -n python3-pywaclient +Summary: A small wrapper library around the World Anvil Aragorn API: https://www.worldanvil.com/api/aragorn/documentation. +Provides: python-pywaclient +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-pywaclient +# World Anvil API Python Client [WIP] + +I am currently in the process of adapting the library to the next +version of the API. This next version is not public yet. If you wish to +get access please message the team to discuss it. + +The latest version which works with Aragorn is `0.12.1`. Use the +highest tag to work with Boromir. + +The World Anvil API provides endpoints to interact with the World Anvil database. + +[Aragorn API Documentation](https://www.worldanvil.com/api/aragorn/documentation) +## Installation +The package is published on PYPI and can be installed with pip. + +`pip --install pywaclient` + +## Usage +This is a simple example on how to use the endpoints. + +```python +import os +from pywaclient.api import BoromirApiClient + +client = BoromirApiClient( + '<YourScriptName>', + '<link-to-your-website-or-bot-repository>', '<version>', os.environ['WA_APPLICATION_KEY'], + os.environ['WA_AUTH_TOKEN'] +) + +# get your own user id. It is not possible to discover the user ids of other users via the API. +authenticated_user = client.user.identity() + +# get the references to all the worlds on your account. +worlds = [world for world in client.user.worlds(authenticated_user['id'])] + +# get the references to all the category on the first world. +categories = [category for category in client.world.categories(worlds[0]['id'])] + +# gets a list of all the articles without a category in the first world +articles = [article for article in client.category.articles(worlds[0]['id'], '-1')] + +# gets the full content of the first article +article = client.article.get(articles[0]['id'], 2) + +# gets the full content of the first category. Categories and most other resources do not have a granularity of 2. +category = client.category.get(categories[0]['id'], 1) +``` + + + + + +%package help +Summary: Development documents and examples for pywaclient +Provides: python3-pywaclient-doc +%description help +# World Anvil API Python Client [WIP] + +I am currently in the process of adapting the library to the next +version of the API. This next version is not public yet. If you wish to +get access please message the team to discuss it. + +The latest version which works with Aragorn is `0.12.1`. Use the +highest tag to work with Boromir. + +The World Anvil API provides endpoints to interact with the World Anvil database. + +[Aragorn API Documentation](https://www.worldanvil.com/api/aragorn/documentation) +## Installation +The package is published on PYPI and can be installed with pip. + +`pip --install pywaclient` + +## Usage +This is a simple example on how to use the endpoints. + +```python +import os +from pywaclient.api import BoromirApiClient + +client = BoromirApiClient( + '<YourScriptName>', + '<link-to-your-website-or-bot-repository>', '<version>', os.environ['WA_APPLICATION_KEY'], + os.environ['WA_AUTH_TOKEN'] +) + +# get your own user id. It is not possible to discover the user ids of other users via the API. +authenticated_user = client.user.identity() + +# get the references to all the worlds on your account. +worlds = [world for world in client.user.worlds(authenticated_user['id'])] + +# get the references to all the category on the first world. +categories = [category for category in client.world.categories(worlds[0]['id'])] + +# gets a list of all the articles without a category in the first world +articles = [article for article in client.category.articles(worlds[0]['id'], '-1')] + +# gets the full content of the first article +article = client.article.get(articles[0]['id'], 2) + +# gets the full content of the first category. Categories and most other resources do not have a granularity of 2. +category = client.category.get(categories[0]['id'], 1) +``` + + + + + +%prep +%autosetup -n pywaclient-1.3.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-pywaclient -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 15 2023 Python_Bot <Python_Bot@openeuler.org> - 1.3.4-1 +- Package Spec generated |