{ "info": { "author": "James Errico", "author_email": "james.errico@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python", "Programming Language :: Python :: 2.7" ], "description": "python-gamesdb\n==============\n\nGitHub: (https://github.com/jameserrico/python-gamesdb)\n\npython-gamesdb is a python client for thegamesdb.net API\n(http://wiki.thegamesdb.net/index.php?title=API\\_Introduction)\n\nPresently, most but not all API calls are supported. Retrieval for most\nimages has not yet been developed, however it is fairly complete for\nfetching data about games and platforms.\n\nInstallation\n============\n\n::\n\n pip install gamesdb\n\nPrerequisites\n-------------\n\nThe prerequisites for this pacakge are generally provided as a part of\nbase Python and should not require any special installation.\n\n- `urllib `__: Installed\n by default with most modern Python interpreters. Used to make HTTP\n requests and read responses.\n\nUsage\n=====\n\nBasics\n------\n\nIn order to use this library you must first instantiate a GamesDB\nobject.\n\n.. code:: python\n\n from gamesdb.api import API\n gamesdb_api = API()\n\nSpecific Calls\n--------------\n\nGet Platforms List\n~~~~~~~~~~~~~~~~~~\n\n`GamesDB GetPlatformsList API\nCall `__\n\nThis call takes no arguments, and returns a list of Platform objects,\nwith the id, name, and alias fields supplied:\n\n.. code:: python\n\n platform_list = gamesdb_api.get_platforms_list()\n for platform in platform_list:\n print platform.id, \"-\", platform.name, \"-\", platform.alias\n\n**Output:**\n\n::\n\n 5 - 3DO - 3do\n 4911 - Amiga - amiga\n 4914 - Amstrad CPC - amstrad-cpc\n 4916 - Android - amstrad-cpc\n 23 - Arcade - arcade\n 22 - Atari 2600 - atari-2600\n ...\n\nGet Platform\n~~~~~~~~~~~~\n\n`GamesDB GetPlatform API\nCall `__\n\nThis call retrieves all available details for a platform, based off of\nthe id returned in get\\_platforms\\_list().\n\n.. code:: python\n\n atari_platform = gamesdb_api.get_platform('22')\n print atari_platform.name\n print atari_platform.overview\n\n**Output:**\n\n::\n\n Atari 2600\n The Atari 2600 is a video game console released in October 1977 by Atari, Inc. It is credited with popularizing the use of microprocessor-based hardware and cartridges containing game code, instead of having non-microprocessor dedicated hardware with all games built in. The first game console to use this format was the Fairchild Channel F; however, the Atari 2600 receives credit for making the plug-in concept popular among the game-playing public.\n The console was originally sold as the Atari VCS, for Video Computer System. Following the release of the Atari 5200, in 1982, the VCS was renamed "Atari 2600", after the unit's Atari part number, CX2600. The 2600 was typically bundled with two joystick controllers, a conjoined pair of paddle controllers, and a cartridge game\u2014initially Combat and later Pac-Man.\n\n The Atari 2600 was wildly successful, and during much of the 1980s, "Atari" was a synonym for this model in mainstream media and, by extension, for video games in general.\n\nGet Platform Games\n~~~~~~~~~~~~~~~~~~\n\n`GamesDB GetPlatformGames API\nCall `__\n\nRetrieve a list of games based on the platform id retrieved in\nget\\_platform\\_list, with id, title, and (if available) release date\npopulated. Note that at the moment, release date comes back\ninconsistently formatted based on what the API response supplies.\n\n.. code:: python\n\n atari_games_list = gamesdb_api.get_platform_games('22') # Atari 2600 Platform id\n for game in atari_games_list:\n print game.id, \"-\", game.title, \"-\", game.release_date\n\n**Output:**\n\n::\n\n 206 - Commando - None\n 207 - Dig Dug - 01/01/1982\n 10128 - H.E.R.O. - 01/01/1984\n 1292 - Ghostbusters - 1984\n 1341 - Amidar - 01/01/1982\n 1342 - Asteroids - 08/01/1979\n 1343 - Battlezone - 01/01/1983\n 1344 - Blackjack - 01/01/1977\n 1345 - Casino - None\n 1346 - Centipede - 01/01/1982\n 1347 - Defender - 01/01/1980\n 1348 - Gravitar - None\n 1349 - Indy 500 - 01/01/1977\n 1350 - Joust - None\n ...\n\nGet Game\n~~~~~~~~\n\n`GamesDB GetGame API\nCall `__\n\nRetrieve all of the available details for a game or list of games, based\noff of the game id or name. If passing in name, you may optionally\nfilter results by Platform. Note that when your query returns only one\ngame (as it the case when querying by id) it will return one game. When\nyour query returns more than one item, it will return a list of Games.\nWhen your query returns no results, None will be returned.\n\nNote that GetGame will tree name arguments with spaces as an OR search\noperation. For example searching where name=\"mega man\" will return all\ngames containing either \"mega\" or \"man\" in their title. This is\ndifferent that GetGamesList, which would treat the same search as an AND\noperation.\n\nGet Game by id\n^^^^^^^^^^^^^^\n\n.. code:: python\n\n game = gamesdb_api.get_game(id=\"1350\")\n print game.title\n print game.overview\n print game.genres\n print game.developer\n\n**Output:**\n\n::\n\n Joust\n Joust is a platforming game where the player controls a yellow knight riding a flying ostrich from a third-person perspective. The player navigates the protagonist around the game world, which consists of rock platforms floating above a flat island surrounded by lava.\n Platform\n Williams Electronics\n\nGet Game by Name\n^^^^^^^^^^^^^^^^\n\n.. code:: python\n\n mega_man_games = gamesdb_api.get_game(name=\"mega man\")\n for game in mega_man_games:\n print game.title\n print game.platform\n print \"---------------------\"\n\n**Output:**\n\n::\n\n Mega Man\n Nintendo Entertainment System (NES)\n ---------------------\n Mega Man Zero\n Nintendo Game Boy Advance\n ---------------------\n Mega Man Soccer\n Super Nintendo (SNES)\n ---------------------\n Mega Man 3\n Nintendo Game Boy\n ---------------------\n Mega Man Xtreme\n Nintendo Game Boy Color\n ---------------------\n Mega Man X5\n Sony Playstation\n ---------------------\n\n ...\n\n Mega Bomberman\n Sega Mega Drive\n ---------------------\n Mega Turrican\n Sega Genesis\n ---------------------\n Mega Force\n Atari 2600\n ---------------------\n Mega Bomberman\n Sega Genesis\n ---------------------\n Low G Man: The Low Gravity Man\n Nintendo Entertainment System (NES)\n ---------------------\n Mega-Lo-Mania\n Super Nintendo (SNES)\n ---------------------\n WarioWare, Inc.: Mega Microgames!\n Nintendo Game Boy Advance\n ---------------------\n Sonic Mega Collection\n Nintendo GameCube\n ---------------------\n WarioWare, Inc.: Mega Party Games!\n Nintendo GameCube\n ---------------------\n Eight Man\n NeoGeo\n \n\nGet Game by Name and Platform\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n.. code:: python\n\n mega_man_games = gamesdb_api.get_game(name=\"mega man\", platform='Nintendo Entertainment System (NES)')\n for game in mega_man_games:\n print game.title\n print game.platform\n print \"---------------------\"\n\n**Output:**\n\n::\n\n Mega Man\n Nintendo Entertainment System (NES)\n ---------------------\n Mega Man 2\n Nintendo Entertainment System (NES)\n ---------------------\n Mega Man 5\n Nintendo Entertainment System (NES)\n ---------------------\n Mega Man 3\n Nintendo Entertainment System (NES)\n ---------------------\n Mega Man 4\n Nintendo Entertainment System (NES)\n ---------------------\n Mega Man 6\n Nintendo Entertainment System (NES)\n ---------------------\n Low G Man: The Low Gravity Man\n Nintendo Entertainment System (NES)\n ---------------------\n Pac-Man\n Nintendo Entertainment System (NES)\n ---------------------\n Ms. Pac-Man\n Nintendo Entertainment System (NES)\n ---------------------\n Spider-Man: Return of the Sinister Six\n Nintendo Entertainment System (NES)\n ---------------------\n Metal Mech: Man & Machine\n Nintendo Entertainment System (NES)\n ---------------------\n The Simpsons: Bartman Meets Radioactive Man\n Nintendo Entertainment System (NES)\n ... \n\nGet Games List\n~~~~~~~~~~~~~~\n\n`GamesDB GetGamesList API\nCall `__\n\nRetrieve the id, title, release date (when available) and platform for a\nlist of games, based off of the name, and optionally the platform and\ngenre. This call will always return a list of Games.\n\nNote that GetGamesList will treat name arguments with spaces as an AND\nsearch operation. For example searching where name=\"mega man\" will\nreturn all games containing both \"mega\" and \"man\" in their title. This\nis different that GetGame, which would treat the same search as an OR\noperation.\n\nGet Games List by Name\n^^^^^^^^^^^^^^^^^^^^^^\n\n.. code:: python\n\n mega_man_games = gamesdb_api.get_games_list(name=\"mega man\")\n for game in mega_man_games:\n print game.title\n print game.platform\n print game.release_date\n print \"---------------------\"\n\n**Output:**\n\n::\n\n Mega Man\n Nintendo Entertainment System (NES)\n 12/17/1987\n ---------------------\n Mega Man Zero\n Nintendo Game Boy Advance\n 04/26/2002\n ---------------------\n Mega Man 5\n Nintendo Entertainment System (NES)\n 12/04/1992\n ---------------------\n Mega Man X\n Super Nintendo (SNES)\n 01/01/1994\n ---------------------\n Mega Man 7\n Super Nintendo (SNES)\n 03/24/1995\n ---------------------\n Mega Man 2\n Nintendo Entertainment System (NES)\n 11/24/1988\n ---------------------\n Mega Man 3\n Nintendo Entertainment System (NES)\n 09/28/1990\n ---------------------\n Mega Man 4\n Nintendo Entertainment System (NES)\n 12/06/1991\n ---------------------\n Mega Man 6\n Nintendo Entertainment System (NES)\n 10/06/1992\n ---------------------\n Mega Man 8\n Sony Playstation\n 12/17/1996\n ---------------------\n Mega Man Legends\n Sony Playstation\n 08/31/1998\n ---------------------\n Mega Man X4\n Sony Playstation\n 08/10/1997\n ---------------------\n Mega Man X2\n Super Nintendo (SNES)\n 01/01/1995\n ---------------------\n Mega Man X3\n Super Nintendo (SNES)\n 01/01/1996\n ---------------------\n Mega Man 64\n Nintendo 64\n 11/22/2000\n ---------------------\n Mega Man & Bass\n Nintendo Game Boy Advance\n 08/10/2002\n ---------------------\n Mega Man Zero 2\n Nintendo Game Boy Advance\n 05/02/2003\n ---------------------\n Mega Man Zero 3\n Nintendo Game Boy Advance\n 04/23/2004\n ---------------------\n Mega Man Zero 4\n Nintendo Game Boy Advance\n 04/21/2005\n ---------------------\n Mega Man X6\n Sony Playstation\n 12/04/2001\n ---------------------\n\nGet Games List by Name and PLatform\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n.. code:: python\n\n mega_man_games = gamesdb_api.get_games_list(name=\"mega man\", platform='Sony Playstation')\n for game in mega_man_games:\n print game.title\n print game.platform\n print game.release_date\n print \"---------------------\"\n\n**Output:**\n\n::\n\n Mega Man 8\n Sony Playstation\n 12/17/1996\n ---------------------\n Mega Man Legends\n Sony Playstation\n 08/31/1998\n ---------------------\n Mega Man X4\n Sony Playstation\n 08/10/1997\n ---------------------\n Mega Man X6\n Sony Playstation\n 12/04/2001\n ---------------------\n Mega Man X5\n Sony Playstation\n 01/31/2001\n ---------------------\n Mega Man X3\n Sony Playstation\n 04/26/1996\n ---------------------\n Mega Man Battle & Chase\n Sony Playstation\n 11/30/1998\n ---------------------\n Mega Man Legends 2\n Sony Playstation\n 10/24/2000\n ---------------------\n Spider-Man\n Sony Playstation\n 01/01/2001\n ---------------------\n Shadow Man\n Sony Playstation\n 09/30/1999\n ---------------------\n Pac-Man World\n Sony Playstation\n 01/01/2000\n ---------------------\n Action Man: Operation Extreme\n Sony Playstation\n 11/08/2000\n ---------------------\n Pac-Man World 20th Aniversary\n Sony Playstation\n 09/30/1999\n ---------------------\n Ms. Pac-Man Maze Madness\n Sony Playstation\n 09/08/2000\n ---------------------\n Spider-Man 2: Enter Electro\n Sony Playstation\n 08/16/2001\n ---------------------\n Iron Man / X-O Manowar in Heavy Metal\n Sony Playstation\n 10/31/1996\n ---------------------\n\nGet Games List by Name and Genre\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nNote that you can pass in genre and platform independently, name is the\nonly required field.\n\n.. code:: python\n\n mega_man_games = gamesdb_api.get_games_list(name=\"mega man\", platform='Sony Playstation', genre='platform')\n for game in mega_man_games:\n print game.title\n print game.platform\n print game.release_date\n print \"---------------------\"\n\n**Output:**\n\n::\n\n Mega Man X6\n Sony Playstation\n 12/04/2001\n ---------------------\n Mega Man Legends 2\n Sony Playstation\n 10/24/2000\n ---------------------\n Pac-Man World 20th Aniversary\n Sony Playstation\n 09/30/1999\n ---------------------\n\nClasses\n=======\n\nAt present, there are two main class types uses to present results. The\nspecific entries that are populated will vary based off othe query and\nthe actualy data available for your object(s).\n\n- Game\n- id\n- title\n- release\\_date\n- platform\n- overview\n- esrb\\_rating\n- genres\n- players\n- coop\n- youtube\\_url\n- publisher\n- developer\n- rating\n- logo\\_url\n- Platform\n- id\n- name\n- alias\n- console\n- controller\n- overview\n- developer\n- manufacturer\n- cpu\n- memory\n- graphics\n- sound\n- display\n- media\n- max\\_controllers\n- rating\n\n", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jameserrico/python-gamesdb", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "gamesdb", "package_url": "https://pypi.org/project/gamesdb/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/gamesdb/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/jameserrico/python-gamesdb" }, "release_url": "https://pypi.org/project/gamesdb/0.1.1/", "requires_dist": null, "requires_python": null, "summary": "Python client for thegamesdb.net API for retrieving video game data.", "version": "0.1.1" }, "last_serial": 709635, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "3cd03be54a9544ace51f0fc0bcd52dff", "sha256": "2f065316154a998c5b4dcc915b3ea080555253fa387a44e17f203ee1d00745eb" }, "downloads": -1, "filename": "gamesdb-0.1.tar.gz", "has_sig": false, "md5_digest": "3cd03be54a9544ace51f0fc0bcd52dff", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7834, "upload_time": "2013-05-27T16:54:51", "url": "https://files.pythonhosted.org/packages/c3/47/2ea4840570122e43e9973c64c2ca610af7bf173b0f2adab085da02294e65/gamesdb-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "0e0c6149ba06a6ef8258faa3a2286147", "sha256": "652f0c2b2004be31f0da6b0b0f89a0cb5b9d2f4895dc41d2810f80c5ed8b47f1" }, "downloads": -1, "filename": "gamesdb-0.1.1.tar.gz", "has_sig": false, "md5_digest": "0e0c6149ba06a6ef8258faa3a2286147", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7986, "upload_time": "2013-05-27T17:15:00", "url": "https://files.pythonhosted.org/packages/7a/88/5c8bff0e70e19d3dc29a94eec3e03256603d8f614598b85f3a0f849e8d8e/gamesdb-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0e0c6149ba06a6ef8258faa3a2286147", "sha256": "652f0c2b2004be31f0da6b0b0f89a0cb5b9d2f4895dc41d2810f80c5ed8b47f1" }, "downloads": -1, "filename": "gamesdb-0.1.1.tar.gz", "has_sig": false, "md5_digest": "0e0c6149ba06a6ef8258faa3a2286147", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7986, "upload_time": "2013-05-27T17:15:00", "url": "https://files.pythonhosted.org/packages/7a/88/5c8bff0e70e19d3dc29a94eec3e03256603d8f614598b85f3a0f849e8d8e/gamesdb-0.1.1.tar.gz" } ] }