Skip to content

Commit ba71237

Browse files
committed
Update examples in README
1 parent 2bb05ef commit ba71237

File tree

1 file changed

+23
-36
lines changed

1 file changed

+23
-36
lines changed

README.md

Lines changed: 23 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<img src="https://img.shields.io/github/license/dotX12/shazamio.svg" alt="https://github.com/dotX12/ShazamIO/blob/master/LICENSE.txt">
88
<br><br>
99
<img width="1000" src="https://user-images.githubusercontent.com/64792903/109359596-ca561a00-7896-11eb-9c93-9cf1f283b1a5.png">
10-
🎵 Is a FREE asynchronous framework from reverse engineered Shazam API written in Python 3.7+ with asyncio and aiohttp.
10+
🎵 Is a FREE asynchronous framework from reverse engineered Shazam API written in Python 3.6+ with asyncio and aiohttp.
1111
</p>
1212

1313
----
@@ -53,21 +53,20 @@ Retrieving information from an artist profile<br>
5353

5454
```python3
5555
import asyncio
56-
from shazamio import Shazam, FactoryArtist
56+
from shazamio import Shazam, serialize_artist
5757

5858

5959
async def main():
6060
shazam = Shazam()
6161
artist_id = 43328183
6262
about_artist = await shazam.artist_about(artist_id)
63-
serialized = FactoryArtist(data=about_artist).serializer()
63+
serialized = serialize_artist(about_artist)
6464

6565
print(about_artist) # dict
6666
print(serialized) # serialized from dataclass factory
6767

6868
loop = asyncio.get_event_loop()
6969
loop.run_until_complete(main())
70-
7170
```
7271
</details>
7372

@@ -82,14 +81,14 @@ Get track information<br>
8281

8382
```python3
8483
import asyncio
85-
from shazamio import Shazam, FactoryTrack
84+
from shazamio import Shazam, serialize_track
8685

8786

8887
async def main():
8988
shazam = Shazam()
9089
track_id = 552406075
9190
about_track = await shazam.track_about(track_id=track_id)
92-
serialized = FactoryTrack(data=about_track).serializer()
91+
serialized = serialize_track(data=about_track)
9392

9493
print(about_track) # dict
9594
print(serialized) # serialized from dataclass factory
@@ -132,18 +131,19 @@ loop.run_until_complete(main())
132131
Search all artists by prefix<br>
133132
```python3
134133
import asyncio
135-
from shazamio import Shazam, FactoryArtist
134+
from shazamio import Shazam, serialize_artist
136135

137136

138137
async def main():
139138
shazam = Shazam()
140139
artists = await shazam.search_artist(query='Lil', limit=5)
141140
for artist in artists['artists']['hits']:
142-
serialized = FactoryArtist(artist).serializer()
141+
serialized = serialize_artist(data=artist)
143142
print(serialized)
144143

145144
loop = asyncio.get_event_loop()
146145
loop.run_until_complete(main())
146+
147147
```
148148
</details>
149149

@@ -180,15 +180,15 @@ Get the top songs according to Shazam<br>
180180

181181
```python3
182182
import asyncio
183-
from shazamio import Shazam, FactoryTrack
183+
from shazamio import Shazam, serialize_track
184184

185185

186186
async def main():
187187
shazam = Shazam()
188188
artist_id = 201896832
189189
top_three_artist_tracks = await shazam.artist_top_tracks(artist_id=artist_id, limit=3)
190190
for track in top_three_artist_tracks['tracks']:
191-
serialized_track = FactoryTrack(data=track).serializer()
191+
serialized_track = serialize_track(data=track)
192192
print(serialized_track)
193193

194194
loop = asyncio.get_event_loop()
@@ -207,23 +207,22 @@ Retrieving information from an artist profile<br>
207207

208208
```python3
209209
import asyncio
210-
from shazamio import Shazam, FactoryTrack
210+
from shazamio import Shazam, serialize_track
211211

212212

213213
async def main():
214214
shazam = Shazam()
215-
top_ten_moscow_tracks = await shazam.top_city_tracks(country_code='RU',
216-
city_name='Moscow',
217-
limit=10)
215+
top_ten_moscow_tracks = await shazam.top_city_tracks(country_code='RU', city_name='Moscow', limit=10)
218216
print(top_ten_moscow_tracks)
219217
# ALL TRACKS DICT
220218
for track in top_ten_moscow_tracks['tracks']:
221-
serialized = FactoryTrack(track).serializer()
219+
serialized = serialize_track(data=track)
222220
# SERIALIZE FROM DATACLASS FACTORY
223221
print(serialized)
224222

225223
loop = asyncio.get_event_loop()
226224
loop.run_until_complete(main())
225+
227226
```
228227
</details>
229228

@@ -237,14 +236,14 @@ Get the best tracks by country code<br>
237236

238237
```python3
239238
import asyncio
240-
from shazamio import Shazam, FactoryTrack
239+
from shazamio import Shazam, serialize_track
241240

242241

243242
async def main():
244243
shazam = Shazam()
245244
top_five_track_from_amsterdam = await shazam.top_country_tracks('NL', 5)
246245
for track in top_five_track_from_amsterdam['tracks']:
247-
serialized = FactoryTrack(data=track).serializer()
246+
serialized = serialize_track(data=track)
248247
print(serialized)
249248

250249
loop = asyncio.get_event_loop()
@@ -267,7 +266,7 @@ from shazamio import Shazam, GenreMusic
267266

268267
async def main():
269268
shazam = Shazam()
270-
top_spain_rap = await shazam.top_country_genre_tracks(country='ES',
269+
top_spain_rap = await shazam.top_country_genre_tracks(country_code='ES',
271270
genre=GenreMusic.HIP_HOP_RAP,
272271
limit=4)
273272
print(top_spain_rap)
@@ -287,22 +286,20 @@ Get world tracks by certain genre<br>
287286

288287
```python3
289288
import asyncio
290-
from shazamio import Shazam, FactoryTrack, GenreMusic
289+
from shazamio import Shazam, serialize_track, GenreMusic
291290

292291

293292
async def main():
294293
shazam = Shazam()
295294
top_rock_in_the_world = await shazam.top_world_genre_tracks(genre=GenreMusic.ROCK, limit=10)
296295

297296
for track in top_rock_in_the_world['tracks']:
298-
serialized_track = FactoryTrack(track).serializer()
297+
serialized_track = serialize_track(data=track)
299298
print(serialized_track.spotify_url)
300299

301300

302301
loop = asyncio.get_event_loop()
303302
loop.run_until_complete(main())
304-
305-
306303
```
307304
</details>
308305

@@ -316,15 +313,15 @@ Get the best tracks from all over the world<br>
316313

317314
```python3
318315
import asyncio
319-
from shazamio import Shazam, FactoryTrack
316+
from shazamio import Shazam, serialize_track
320317

321318

322319
async def main():
323320
shazam = Shazam()
324321
top_world_tracks = await shazam.top_world_tracks(limit=10)
325322
print(top_world_tracks)
326323
for track in top_world_tracks['tracks']:
327-
serialized = FactoryTrack(track).serializer()
324+
serialized = serialize_track(track)
328325
print(serialized)
329326

330327
loop = asyncio.get_event_loop()
@@ -342,14 +339,14 @@ loop.run_until_complete(main())
342339

343340
```python3
344341
import asyncio
345-
from shazamio import Shazam, FactoryTrack
342+
from shazamio import Shazam, serialize_track
346343

347344

348345
async def main():
349346
shazam = Shazam()
350347
top_five_track_from_amsterdam = await shazam.top_country_tracks('NL', 5)
351348
for track in top_five_track_from_amsterdam['tracks']:
352-
serialized = FactoryTrack(data=track).serializer()
349+
serialized = serialize_track(data=track)
353350
print(serialized.title)
354351

355352
loop = asyncio.get_event_loop()
@@ -374,13 +371,3 @@ loop.run_until_complete(main())
374371
</details>
375372

376373
Agree, thanks to the serializer, you no longer need to manually select the necessary data from the dictionary. Now the serializer contains the most necessary information about an artist or a track.
377-
378-
You can get information on a specific attribute like this:
379-
380-
<details>
381-
<summary>
382-
<i>Open photo: Using an attribute with a Serializer</i>
383-
</summary>
384-
<img src="https://user-images.githubusercontent.com/64792903/109455344-75b5c900-7a67-11eb-9863-a5ecd2859119.png">
385-
386-
</details>

0 commit comments

Comments
 (0)