Metadata-Version: 2.1
Name: soundcloud-charts-api
Version: 1.0.4
Summary: A python wrapper for the Soundcloud Chart API
Home-page: https://github.com/mpalazzolo/soundcloud-charts-api
Author: Matt Palazzolo
Author-email: mattpalazzolo@gmail.com
License: LICENSE.txt
Description: # soundcloud-charts-api
        
        A python wrapper for the Soundcloud Charts API. 
        
        NOTE: This is a wrapper for a public, undocumented API.
        
        ## Getting Started
        
        ### Documentation
        Find full documentation of the project here:
        https://soundcloud-charts-api.readthedocs.io
        
        ### Dependencies
        
        - [Requests](https://github.com/requests/requests) 
        
        
        ### Installing
        
        ```
        python setup.py install
        ```
        
        or
        
        ```
        pip install soundcloud-charts-api
        ```
        
        ### Example
        
        ```python
        from soundcloudcharts import SoundCloudCharts
        
        sc = SoundCloudCharts()
        chart_data = sc.get_chart(region='us', limit=10)
        
        for i, item in enumerate(chart_data['collection']):
            print('{0}: {1} - {2}'.format(str(i+1), 
                                          item['track']['user']['username'], 
                                          item['track']['title']))
        ```
        
        ### API Parameters
        #### KIND:
        - top
        - trending (New & Hot)
        
        #### GENRE:
        - all-music
        - all-audio
        - alternativerock
        - ambient
        - classical
        - country
        - danceedm
        - dancehall
        - deephouse
        - disco
        - drumbass
        - dubstep
        - electronic
        - folksingersongwriter
        - hiphoprap
        - house
        - indie
        - jazzblues
        - latin
        - metal
        - piano
        - pop
        - rbsoul
        - reggae
        - reggaeton
        - rock
        - soundtrack
        - techno
        - trance
        - trap
        - triphop
        - world
        
        
        
        #### REGION:
        - au (Australia)
        - ca (Canada)
        - fr (France)
        - de (Germany)
        - ie (Ireland)
        - nl (Netherlands)
        - nz (New Zealand)
        - gb (Great Britain)
        - us (United States)
        
        
        ## Versioning
        
        - v1.0.1 - Initial Release - 08/18/2019
        - v1.0.2 - Fixed bug when using proxies - 08/19/2019
        - v1.0.3 - Updated file where key is found - 01/01/2020
        - v1.0.4 - Update to automatically find file with key - 03/09/2020
        
        ## Authors
        
        * **Matt Palazzolo** - [GitHub Profile](https://github.com/mpalazzolo)
        
        ## License
        
        This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details
        
        
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
