Skip to content

Commit a6c70d3

Browse files
Galarzaa90Galarzaa90
committed
Added info about docker image to docs
1 parent 2bd536c commit a6c70d3

File tree

1 file changed

+92
-58
lines changed

1 file changed

+92
-58
lines changed

‎docs/intro.rst‎

Lines changed: 92 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -62,68 +62,73 @@ This allows you to use any networking module to obtain the data, and use the lib
6262
Supported Sections
6363
==================
6464

65-
+-------------------------------+--------------------------------------------+---------------------------------------------+
66-
| Section | Parsing | Fetching |
67-
+===============================+============================================+=============================================+
68-
| Characters_ | :meth:`Character.from_content` | :meth:`Client.fetch_character` |
69-
+-------------------------------+--------------------------------------------+---------------------------------------------+
70-
| `Character Bazaar`_ (Current) | :meth:`CharacterBazaar.from_content` | :meth:`Client.fetch_current_auctions` |
71-
+-------------------------------+--------------------------------------------+---------------------------------------------+
72-
| `Character Bazaar`_ (History) | :meth:`CharacterBazaar.from_content` | :meth:`Client.fetch_auction_history` |
73-
+-------------------------------+--------------------------------------------+---------------------------------------------+
74-
| `Character Bazaar`_ (Detail) | :meth:`AuctionDetails.from_content` | :meth:`Client.fetch_auction` |
75-
+-------------------------------+--------------------------------------------+---------------------------------------------+
76-
| Characters_ | :meth:`Character.from_content` | :meth:`Client.fetch_character` |
77-
+-------------------------------+--------------------------------------------+---------------------------------------------+
78-
| `CM Post Archive`_ | :meth:`CMPostArchive.from_content` | :meth:`Client.fetch_cm_post_archive` |
79-
+-------------------------------+--------------------------------------------+---------------------------------------------+
80-
| `Event Schedule`_ | :meth:`EventSchedule.from_content` | :meth:`Client.fetch_event_schedule` |
81-
+-------------------------------+--------------------------------------------+---------------------------------------------+
82-
| Guilds_ (Individual) | :meth:`Guild.from_content` | :meth:`Client.fetch_guild` |
83-
+-------------------------------+--------------------------------------------+---------------------------------------------+
84-
| Guilds_ (List) | :meth:`ListedGuild.list_from_content` | :meth:`Client.fetch_world_guilds` |
85-
+-------------------------------+--------------------------------------------+---------------------------------------------+
86-
| Guilds_ (Wars) | :meth:`GuildWars.from_content` | :meth:`Client.fetch_guild_wars` |
87-
+-------------------------------+--------------------------------------------+---------------------------------------------+
88-
| Forums_ (Section) | :meth:`ListedBoard.list_from_content` | :meth:`Client.fetch_forum_world_boards` |
89-
| | | :meth:`Client.fetch_forum_trade_boards` |
90-
| | | :meth:`Client.fetch_forum_community_boards` |
91-
| | | :meth:`Client.fetch_forum_support_boards` |
92-
+-------------------------------+--------------------------------------------+---------------------------------------------+
93-
| Forums_ (Board) | :meth:`ForumBoard.from_content` | :meth:`Client.fetch_forum_board` |
94-
+-------------------------------+--------------------------------------------+---------------------------------------------+
95-
| Forums_ (Announcement) | :meth:`ForumAnnouncement.from_content` | :meth:`Client.fetch_forum_announcement` |
96-
+-------------------------------+--------------------------------------------+---------------------------------------------+
97-
| Forums_ (Thread) | :meth:`ForumThread.from_content` | :meth:`Client.fetch_forum_thread` |
98-
+-------------------------------+--------------------------------------------+---------------------------------------------+
99-
| Highscores_ | :meth:`Highscores.from_content` | :meth:`Client.fetch_highscores_page` |
100-
+-------------------------------+--------------------------------------------+---------------------------------------------+
101-
| Highscores_ | :meth:`Highscores.from_content` | :meth:`Client.fetch_highscores_page` |
102-
+-------------------------------+--------------------------------------------+---------------------------------------------+
103-
| Houses_ (Individual) | :meth:`House.from_content` | :meth:`Client.fetch_house` |
104-
+-------------------------------+--------------------------------------------+---------------------------------------------+
105-
| Houses_ (List) | :meth:`ListedHouse.list_from_content` | :meth:`Client.fetch_world_houses` |
106-
+-------------------------------+--------------------------------------------+---------------------------------------------+
107-
| `Kill Statistics`_ (List) | :meth:`KillStatistics.from_content` | :meth:`Client.fetch_kill_statistics` |
108-
+-------------------------------+--------------------------------------------+---------------------------------------------+
109-
| News_ (Individual) | :meth:`News.from_content` | :meth:`Client.fetch_news` |
110-
+-------------------------------+--------------------------------------------+---------------------------------------------+
111-
| News_ (List) | :meth:`ListedNews.list_from_content` | :meth:`Client.fetch_news_archive` |
112-
| | | :meth:`Client.fetch_recent_news` |
113-
+-------------------------------+--------------------------------------------+---------------------------------------------+
114-
| Tournaments_ | :meth:`Tournament.from_content` | :meth:`Client.fetch_tournament` |
115-
+-------------------------------+--------------------------------------------+---------------------------------------------+
116-
| `Tournament Leaderboards`_ | :meth:`TournamentLeaderboard.from_content` | :meth:`Client.fetch_tournament_leaderboard` |
117-
+-------------------------------+--------------------------------------------+---------------------------------------------+
118-
| Worlds_ (Individual) | :meth:`World.from_content` | :meth:`Client.fetch_world` |
119-
+-------------------------------+--------------------------------------------+---------------------------------------------+
120-
| Worlds_ (List) | :meth:`WorldOverview.from_content` | :meth:`Client.fetch_world_list` |
121-
+-------------------------------+--------------------------------------------+---------------------------------------------+
65+
+----------------------------------+--------------------------------------------+---------------------------------------------+
66+
| Section | Parsing | Fetching |
67+
+==================================+============================================+=============================================+
68+
| Characters_ | :meth:`Character.from_content` | :meth:`Client.fetch_character` |
69+
+----------------------------------+--------------------------------------------+---------------------------------------------+
70+
| `Character Bazaar`_ (Current) | :meth:`CharacterBazaar.from_content` | :meth:`Client.fetch_current_auctions` |
71+
+----------------------------------+--------------------------------------------+---------------------------------------------+
72+
| `Character Bazaar`_ (History) | :meth:`CharacterBazaar.from_content` | :meth:`Client.fetch_auction_history` |
73+
+----------------------------------+--------------------------------------------+---------------------------------------------+
74+
| `Character Bazaar`_ (Detail) | :meth:`AuctionDetails.from_content` | :meth:`Client.fetch_auction` |
75+
+----------------------------------+--------------------------------------------+---------------------------------------------+
76+
| Characters_ | :meth:`Character.from_content` | :meth:`Client.fetch_character` |
77+
+----------------------------------+--------------------------------------------+---------------------------------------------+
78+
| `CM Post Archive`_ | :meth:`CMPostArchive.from_content` | :meth:`Client.fetch_cm_post_archive` |
79+
+----------------------------------+--------------------------------------------+---------------------------------------------+
80+
| `Creature Library`_ (List) | :meth:`CreaturesSection.from_content` | :meth:`Client.fetch_library_creatures` |
81+
+----------------------------------+--------------------------------------------+---------------------------------------------+
82+
| `Creature Library`_ (Individual) | :meth:`CreatureDetail.from_content` | :meth:`Client.fetch_creature` |
83+
+----------------------------------+--------------------------------------------+---------------------------------------------+
84+
| `Event Schedule`_ | :meth:`EventSchedule.from_content` | :meth:`Client.fetch_event_schedule` |
85+
+----------------------------------+--------------------------------------------+---------------------------------------------+
86+
| Guilds_ (Individual) | :meth:`Guild.from_content` | :meth:`Client.fetch_guild` |
87+
+----------------------------------+--------------------------------------------+---------------------------------------------+
88+
| Guilds_ (List) | :meth:`ListedGuild.list_from_content` | :meth:`Client.fetch_world_guilds` |
89+
+----------------------------------+--------------------------------------------+---------------------------------------------+
90+
| Guilds_ (Wars) | :meth:`GuildWars.from_content` | :meth:`Client.fetch_guild_wars` |
91+
+----------------------------------+--------------------------------------------+---------------------------------------------+
92+
| Forums_ (Section) | :meth:`ListedBoard.list_from_content` | :meth:`Client.fetch_forum_world_boards` |
93+
| | | :meth:`Client.fetch_forum_trade_boards` |
94+
| | | :meth:`Client.fetch_forum_community_boards` |
95+
| | | :meth:`Client.fetch_forum_support_boards` |
96+
+----------------------------------+--------------------------------------------+---------------------------------------------+
97+
| Forums_ (Board) | :meth:`ForumBoard.from_content` | :meth:`Client.fetch_forum_board` |
98+
+----------------------------------+--------------------------------------------+---------------------------------------------+
99+
| Forums_ (Announcement) | :meth:`ForumAnnouncement.from_content` | :meth:`Client.fetch_forum_announcement` |
100+
+----------------------------------+--------------------------------------------+---------------------------------------------+
101+
| Forums_ (Thread) | :meth:`ForumThread.from_content` | :meth:`Client.fetch_forum_thread` |
102+
+----------------------------------+--------------------------------------------+---------------------------------------------+
103+
| Highscores_ | :meth:`Highscores.from_content` | :meth:`Client.fetch_highscores_page` |
104+
+----------------------------------+--------------------------------------------+---------------------------------------------+
105+
| Highscores_ | :meth:`Highscores.from_content` | :meth:`Client.fetch_highscores_page` |
106+
+----------------------------------+--------------------------------------------+---------------------------------------------+
107+
| Houses_ (Individual) | :meth:`House.from_content` | :meth:`Client.fetch_house` |
108+
+----------------------------------+--------------------------------------------+---------------------------------------------+
109+
| Houses_ (List) | :meth:`ListedHouse.list_from_content` | :meth:`Client.fetch_world_houses` |
110+
+----------------------------------+--------------------------------------------+---------------------------------------------+
111+
| `Kill Statistics`_ (List) | :meth:`KillStatistics.from_content` | :meth:`Client.fetch_kill_statistics` |
112+
+----------------------------------+--------------------------------------------+---------------------------------------------+
113+
| News_ (Individual) | :meth:`News.from_content` | :meth:`Client.fetch_news` |
114+
+----------------------------------+--------------------------------------------+---------------------------------------------+
115+
| News_ (List) | :meth:`ListedNews.list_from_content` | :meth:`Client.fetch_news_archive` |
116+
| | | :meth:`Client.fetch_recent_news` |
117+
+----------------------------------+--------------------------------------------+---------------------------------------------+
118+
| Tournaments_ | :meth:`Tournament.from_content` | :meth:`Client.fetch_tournament` |
119+
+----------------------------------+--------------------------------------------+---------------------------------------------+
120+
| `Tournament Leaderboards`_ | :meth:`TournamentLeaderboard.from_content` | :meth:`Client.fetch_tournament_leaderboard` |
121+
+----------------------------------+--------------------------------------------+---------------------------------------------+
122+
| Worlds_ (Individual) | :meth:`World.from_content` | :meth:`Client.fetch_world` |
123+
+----------------------------------+--------------------------------------------+---------------------------------------------+
124+
| Worlds_ (List) | :meth:`WorldOverview.from_content` | :meth:`Client.fetch_world_list` |
125+
+----------------------------------+--------------------------------------------+---------------------------------------------+
122126

123127

124128
.. _Characters: https://www.tibia.com/community/?subtopic=characters
125129
.. _Character Bazaar: https://www.tibia.com/charactertrade/?subtopic=currentcharactertrades
126130
.. _CM Post Archive: https://www.tibia.com/forum/?subtopic=forum&action=cm_post_archive
131+
.. _Creature Library: https://www.tibia.com/library/?subtopic=creatures
127132
.. _Event Schedule: https://www.tibia.com/news/?subtopic=eventcalendar
128133
.. _Guilds: https://www.tibia.com/community/?subtopic=guilds
129134
.. _Forums: https://www.tibia.com/community/?subtopic=forum
@@ -133,4 +138,33 @@ Supported Sections
133138
.. _News: https://www.tibia.com/news/?subtopic=newsarchive
134139
.. _Worlds: https://www.tibia.com/community/?subtopic=worlds
135140
.. _Tournaments: https://www.tibia.com/community/?subtopic=tournament
136-
.. _Tournament Leaderboards: https://www.tibia.com/community/?subtopic=tournamentleaderboards
141+
.. _Tournament Leaderboards: https://www.tibia.com/community/?subtopic=tournamentleaderboards
142+
143+
144+
Docker
145+
======
146+
A ready to use HTTP server is also available as a Docker image, allowing you to integrate tibia.py in projects using other languages other than Python.
147+
148+
The image can be pulled from `Docker Hub`_:
149+
150+
.. code-block:: sh
151+
152+
docker pull galarzaa90/tibia.py
153+
154+
Alternatively, the image can be built from the root of the project's source.
155+
156+
To run the image:
157+
158+
.. code-block:: sh
159+
160+
docker run \
161+
-p 8000:8000 \
162+
--rm -ti \
163+
galarzaa90/tibia.py
164+
165+
The root location shows a list of the available routes.
166+
167+
.. _Docker Hub: https://hub.docker.com/r/galarzaa90/tibia.py
168+
169+
.. note::
170+
Documentation for endpoints and JSON schemas is not yet available.

0 commit comments

Comments
 (0)