Unofficial API for pitchfork.com reviews, maintained version of pitchfork
Project description
pitchfork-api
=============
An unofficial python API for
`pitchfork.com <http://www.pitchfork.com>`__ reviews.
+------------------+--------------------+--------------------+
| Build Status | Version | Python Versions |
+==================+====================+====================+
| |Build Status| | |Latest Version| | |Py Versions| |
+------------------+--------------------+--------------------+
Apologies for the confusing naming - pypi doesn't allow the use of underscores in package names, while python doesn't allow dashes in module names. As a result, the package name is `pitchfork-api`, but it is `pitchfork_api` everywhere else.
Installation
------------
You can get it from `python package
index <https://pypi.python.org/pypi>`__:
.. code:: sh
pip install pitchfork-api
You can also clone the repository, but note that ``pitchfork`` depends
on ``beautifulsoup4`` for HTML parsing so you first have to install
``beautifulsoup4`` yourself !!!
.. code:: sh
git clone https://github.com/tejassharma96/pitchfork_api
Usage
-----
.. code:: python
>> import pitchfork
>> p = pitchfork.search('kanye west', 'my beautiful') # the title is autocompleted
>> p.album() # the full album title
u'My Beautiful Dark Twisted Fantasy'
>> p.label()
u'Def Jam / Roc-A-Fella'
>> p.editorial()[:100] # get the first 100 characters of the review.
u"Kanye West's 35-minute super-video,\xa0Runaway, peaks with a parade. Fireworks flash while red hoods ma"
# the link to the album cover image
>> p.cover()
'http://cdn4.pitchfork.com/albums/15935/homepage_large.831179e9.jpg'
>> p.score()
10.0
# to check what methods are available, you can use 'methods()'
>> p.methods()
score()
abstract()
editorial()
full_text()
cover()
artist()
album()
label()
year()
Tests
-----
You can run the basic tests located in the ``tests`` directory with:
.. code:: sh
$ cd pitchfork
$ python3 -m unittest discover
License
-------
MIT
Contributions
-------------
If you want to add some new feature, suggest improvement or whatnot
you're welcome to message me or send a pull request!
.. |Build Status| image:: https://travis-ci.org/tejassharma96/pitchfork_api.svg?branch=master
:target: https://travis-ci.org/tejassharma96/pitchfork_api
.. |Latest Version| image:: https://pypip.in/v/pitchfork-api/badge.png
:target: https://pypi.python.org/pypi/pitchfork-api/
.. |PyVersions| image:: https://img.shields.io/pypi/pyversions/pitchfork-api.svg?maxAge=2592000
:target: https://img.shields.io/pypi/pyversions/
=============
An unofficial python API for
`pitchfork.com <http://www.pitchfork.com>`__ reviews.
+------------------+--------------------+--------------------+
| Build Status | Version | Python Versions |
+==================+====================+====================+
| |Build Status| | |Latest Version| | |Py Versions| |
+------------------+--------------------+--------------------+
Apologies for the confusing naming - pypi doesn't allow the use of underscores in package names, while python doesn't allow dashes in module names. As a result, the package name is `pitchfork-api`, but it is `pitchfork_api` everywhere else.
Installation
------------
You can get it from `python package
index <https://pypi.python.org/pypi>`__:
.. code:: sh
pip install pitchfork-api
You can also clone the repository, but note that ``pitchfork`` depends
on ``beautifulsoup4`` for HTML parsing so you first have to install
``beautifulsoup4`` yourself !!!
.. code:: sh
git clone https://github.com/tejassharma96/pitchfork_api
Usage
-----
.. code:: python
>> import pitchfork
>> p = pitchfork.search('kanye west', 'my beautiful') # the title is autocompleted
>> p.album() # the full album title
u'My Beautiful Dark Twisted Fantasy'
>> p.label()
u'Def Jam / Roc-A-Fella'
>> p.editorial()[:100] # get the first 100 characters of the review.
u"Kanye West's 35-minute super-video,\xa0Runaway, peaks with a parade. Fireworks flash while red hoods ma"
# the link to the album cover image
>> p.cover()
'http://cdn4.pitchfork.com/albums/15935/homepage_large.831179e9.jpg'
>> p.score()
10.0
# to check what methods are available, you can use 'methods()'
>> p.methods()
score()
abstract()
editorial()
full_text()
cover()
artist()
album()
label()
year()
Tests
-----
You can run the basic tests located in the ``tests`` directory with:
.. code:: sh
$ cd pitchfork
$ python3 -m unittest discover
License
-------
MIT
Contributions
-------------
If you want to add some new feature, suggest improvement or whatnot
you're welcome to message me or send a pull request!
.. |Build Status| image:: https://travis-ci.org/tejassharma96/pitchfork_api.svg?branch=master
:target: https://travis-ci.org/tejassharma96/pitchfork_api
.. |Latest Version| image:: https://pypip.in/v/pitchfork-api/badge.png
:target: https://pypi.python.org/pypi/pitchfork-api/
.. |PyVersions| image:: https://img.shields.io/pypi/pyversions/pitchfork-api.svg?maxAge=2592000
:target: https://img.shields.io/pypi/pyversions/
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pitchfork_api-0.0.3.tar.gz
(6.5 kB
view hashes)
Built Distribution
Close
Hashes for pitchfork_api-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0f59b306521b34ae22166987e58a0bd27044d4a2544e58864196219a38ae7d7 |
|
MD5 | bcc36be89d2309834f4cd378556d7355 |
|
BLAKE2b-256 | 287abdb2be80b6545c9b660228f4abb2a3e49dc8cf3929ab2d55b0f9908cea4b |