Package: pydori
PydoriA python wrapper to provide easier access to the bandori party and bandori database public APIs.ContentsInfoInstallationUsageExamplesDocumentationContributingAlternativesLicenseCreditsInfoBoth bandori party and bandori database provide extensive public bang dream apis. The purpose of this package is to simplify accessing the various endpoints they provide, while providing sufficient detailed documentation. Additional helper functions and classes are used to automate manual tasks. Users are able to choose between the Bandori Party API or the Bandori Database API.Featuresbandori party endpointsbandori database endpointsOOP class designMake use of the bandori party and bandori database api in one packageadditional functions to improve productivityCurrent Bandori Party EndpointsCardsMembersEventsCostumesItemsAreaitemsAssetsCurrent Bandori Database EndpointsCardsMembersCurrent EventBandsSongsGachasStampComicDegreesInstallationUse pip to install:pip install pydoriUsageRead this to get started on pydori:Create a bandori api instance by using thebandori_api()function. The function returns a class whose functions you can use. Bandori party api does not rely on region; Bandori database api does.importpydoribapi=pydori.bandori_api()# uses all default settings# This uses the bandori database api.# bapi = pydori.bandori_api(region='jp/', party=False)Use the bandori api class functions to access the endpoint you want. All requests made in this wrapper are GET requests using the requests module. See the documentation for what functions to use. The basic syntax is simple:get_{endpoint}(), called on the api class. They usually return lists.cards=bapi.get_cards()GET requests can take optional argumentsidandfilters.idis a list of integers corresponding to the ids of the objects you want to get.filtersare search terms you want to filter by: the key is the category to filter, and the value is the actual value to filter by (ie. results will only include objects that have this value for this corresponding key).cards=bapi.get_cards(id=[511],filters={})BandoriObjects are returned from the requests. The original json object will always be stored inBandoriObject.databut all (or most) of the terms can be accessed directly as class attributes. There can also be helper functions in these objects that speed up accessing relevant data.cards=bapi.get_cards(id=[511])card=cards[0]rimi=card.get_card_member()# returns a PMember objectprint(rimi.name)See the documentation, in the models section, to understand how to work with BandoriObjects. Thequick start guideexplains a bit more in detail how to get use pydori.ExamplesThis example instantiates a PBandoriApi object, gets a card by ID, and displays the card's name.importpydorib=pydori.bandori_api()result=b.get_cards(id=[511])card=result[0]print(card.name)Here we get the current event and display the start and end times:frompydoriimportbandori_apib=bandori_api()current=b.get_current_event()print(current.get_start_date())print(current.get_end_date())Pydori accepts filters for the objects, as a dictionary. This example shows how to get all songs by the band "Roselia".importpydorib=pydori.bandori_api(region='en/',party=False)roselia_songs=b.get_songs(id=[],filters={'bandName':'Roselia'})DocumentationThe documentation is on thegithub wiki page.ContributingSeecontributing.AlternativesThere are a couple of node packages that serve the same purpose, most notablynode-dori. If you're more familiar with javascript you could go search for those. This seems to be the only port in python so far, though.LicenseThis project is licensed under the MIT license.CreditsAPI provided bybandori.partyandbandori database.I do not own any logos, images, or assets of the BanG Dream! Franchise, they are the property and trademark of Bushiroad.