From db22cf6cf740daa0bdc4f7f7bbcc4290e59d0dd2 Mon Sep 17 00:00:00 2001 From: 201st-Luka Date: Fri, 15 Sep 2023 23:54:17 +0200 Subject: [PATCH] docs: tutorials --- docs/Tutorials/01_installation.md | 10 +++++++++- docs/Tutorials/11_setting_up_a_Client.md | 18 ++++++++++++++++++ docs/Tutorials/12_Requests.md | 7 +++++++ 3 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 docs/Tutorials/12_Requests.md diff --git a/docs/Tutorials/01_installation.md b/docs/Tutorials/01_installation.md index e7ade93..ea8e817 100644 --- a/docs/Tutorials/01_installation.md +++ b/docs/Tutorials/01_installation.md @@ -2,4 +2,12 @@ ## Requirements -To use the [PyClasher](../index.md)-package you need Python 3.8 or higher. \ No newline at end of file +To use the [PyClasher](../index.md)-package you need Python 3.8 or higher. + +## Installation + +The package is accessible on [PyPi.org](pypi.org) so you can install the package +using +```bash +pip install pyclasher +``` \ No newline at end of file diff --git a/docs/Tutorials/11_setting_up_a_Client.md b/docs/Tutorials/11_setting_up_a_Client.md index e69de29..5992022 100644 --- a/docs/Tutorials/11_setting_up_a_Client.md +++ b/docs/Tutorials/11_setting_up_a_Client.md @@ -0,0 +1,18 @@ +# Setting up a Client + +The [Client][client_ref] +is the heard of this package. It allows to make the requests. + +## The client + +The [Client][client_ref] uses API tokens that you can obtain from the official +[ClashOfClans developer portal](https://developer.clashofclans.com/#/). Those +tokens serve as a verification to the ClashOfClans API. It is sufficient to +create an account and create one or multiple tokens. + + + + + +[client_ref]: ../API%20Reference/client/client.md#pyclasher.client.client.Client + diff --git a/docs/Tutorials/12_Requests.md b/docs/Tutorials/12_Requests.md new file mode 100644 index 0000000..50e0d9b --- /dev/null +++ b/docs/Tutorials/12_Requests.md @@ -0,0 +1,7 @@ +# Requests + +The requests defined in this package are a user-friendly implementation of +requesting and getting data of the official ClashOfClans-API. The requests +return models that are some kind of wrapper for the data that hides behind the +models. Those models have error handling and are easier to use than raw JSON +data. \ No newline at end of file