medium-api


Namemedium-api JSON
Version 0.5.7 PyPI version JSON
download
home_pagehttps://github.com/weeping-angel/medium-api
SummaryPython Wrapper on top of Medium API to quickly extract data from https://medium.com.
upload_time2024-03-03 16:34:01
maintainer
docs_urlNone
authorNishu Jain
requires_python>=3.6
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ..
        Readme page for github and PyPI

========================
Medium API (Unofficial)
========================

.. image:: https://img.shields.io/pypi/v/medium-api?label=PyPI
        :target: https://pypi.python.org/pypi/medium_api
        :alt: PYPI Package Version

.. image:: https://img.shields.io/pypi/dm/medium-api?color=darkgreen&label=Downloads
        :target: https://pypistats.org/packages/medium-api
        :alt: PYPI Monthly Download Stats

.. image:: https://readthedocs.org/projects/medium-api/badge/?version=latest
        :target: https://medium-api.readthedocs.io/en/latest/?version=latest
        :alt: RTD Documentation Status

.. image:: https://github.com/weeping-angel/medium-api/actions/workflows/tests.yml/badge.svg
        :alt: Github Actions Tests

|

.. image:: https://raw.githubusercontent.com/weeping-angel/medium-api/main/docs/_static/MediumAPI-GettingStarted-Thumbnail.png
        :target: https://www.youtube.com/watch?v=oc8TKG9EQfE
        :alt: What is Medium API?
        :align: center

|

.. image:: https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white
        :target: https://twitter.com/medium_api
        :alt: Twitter

.. image:: https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white
        :target: https://www.linkedin.com/company/medium-api
        :alt: LinkedIn

.. image:: https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white
        :target: https://nishu-jain.medium.com
        :alt: Medium

|

Python Wrapper on top of `Unofficial Medium API <http://hub.mediumapi.com>`_ to quickly extract data from Medium's website (https://medium.com).

Installation
------------

Install from `PyPI <https://pypi.org/project/medium-api/>`_

.. code-block:: console

        $ pip install medium-api


| For more information, see `Detailed Installation <https://medium-api.readthedocs.io/en/latest/installation.html>`_

Example
-------

Getting a Medium user's information and fetching his articles.

.. code-block:: python

        from medium_api import Medium
        
        medium = Medium('YOUR_RAPIDAPI_KEY')

        user = medium.user(username="nishu-jain")

        print(f'{user.fullname} has {user.followers_count} followers.')

        user.fetch_articles()
        for article in user.articles:
                print(article.title)


For more examples, see `Usage <https://medium-api.readthedocs.io/en/latest/usage.html>`_ 

How to get your RapidAPI Key
----------------------------

.. image:: https://img.youtube.com/vi/-MM1C6mb-mc/0.jpg
        :align: center
        :target: https://www.youtube.com/watch?v=-MM1C6mb-mc
        :alt: How to get your RapidAPI Key (Subscribe to Medium API)

Steps:

        - Sign up on `RapidAPI Platform <https://rapidapi.com/auth/sign-up>`_
        - Subscribe to our `Unofficial Medium-API <http://hub.mediumapi.com/pricing>`_
        - Go to the API's *Endpoints* tab on the `RapidAPI Hub listing <http://hub.mediumapi.com>`_ and select the API key from the **X-RapidAPI-Key** dropdown under *Header Parameters* section.

For more details, see the following links:

        - https://rapidapi.com/blog/api-glossary/api-key/
        - https://docs.rapidapi.com/docs/keys

Features
--------

Extract/Scrape/Fetch/Get:
  
    - Medium User information and User-written Articles
    - Medium User's Followers and Following
    - Medium Articles information
    - Medium Article's Textual Content and Markdown
    - Medium Article's Responses/Comments 
    - Medium Publications information
    - Medium Publication's Articles
    - Medium Publication's Newsletter Info
    - Medium's Top Writers
    - Medium's Topfeeds (Trending, Latest, All time best, best of year/month/week)
    - Medium's LatestPosts (distributed articles)


Documentation
-------------

Full Documentation at https://medium-api.readthedocs.io

Other Materials
---------------

Medium REST API:

        - Swagger Documentation: https://docs.mediumapi.com

.. Related Articles:

..         - `Medium API - Documentation <https://medium.com/p/90a01549d8db>`_
..         - `Medium API: Get Posts Using Python <https://medium.com/p/126d6d859ca8>`_
..         - `Authenticate Medium Users Using Medium API <https://medium.com/p/ed7c1c1bcd66>`_
..         - `Medium Notification Service <https://medium.com/p/ff6369938b63>`_
..         - `How To List Hundreds of Niche Top Writers of Medium <https://medium.com/p/78e426bb7b39>`_
..         - `How To Retrieve Medium Stories of a User Using API? <https://medium.com/p/fcdb1576558a>`_
..         - `Medium API: Get Posts Using Node.js & Axios <https://medium.com/p/a43894efaeab>`_

.. Miscellaneous Articles:

..         - `Best Metric to Judge a Medium Article's Popularity <https://medium.com/p/cac577609bd4>`_
..         - `How To Leverage Medium for Crypto-trading <https://medium.com/p/deedea890da1>`_

License
-------

Free software: `MIT license <https://raw.githubusercontent.com/weeping-angel/medium-api/main/LICENSE>`_

EULA: `Terms of Use <https://medium-api.readthedocs.io/en/latest/terms_of_use.html>`_

Code of Conduct
---------------

In the interest of fostering an open and welcoming environment, all contributors, maintainers 
and users are expected to abide by the Python code of conduct: https://www.python.org/psf/codeofconduct/


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/weeping-angel/medium-api",
    "name": "medium-api",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Nishu Jain",
    "author_email": "nishujain1997.19@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/ce/29/55dec1effd38f3313fb7edfd516209046379d21766f8ac423440265b655f/medium-api-0.5.7.tar.gz",
    "platform": "unix",
    "description": "..\n        Readme page for github and PyPI\n\n========================\nMedium API (Unofficial)\n========================\n\n.. image:: https://img.shields.io/pypi/v/medium-api?label=PyPI\n        :target: https://pypi.python.org/pypi/medium_api\n        :alt: PYPI Package Version\n\n.. image:: https://img.shields.io/pypi/dm/medium-api?color=darkgreen&label=Downloads\n        :target: https://pypistats.org/packages/medium-api\n        :alt: PYPI Monthly Download Stats\n\n.. image:: https://readthedocs.org/projects/medium-api/badge/?version=latest\n        :target: https://medium-api.readthedocs.io/en/latest/?version=latest\n        :alt: RTD Documentation Status\n\n.. image:: https://github.com/weeping-angel/medium-api/actions/workflows/tests.yml/badge.svg\n        :alt: Github Actions Tests\n\n|\n\n.. image:: https://raw.githubusercontent.com/weeping-angel/medium-api/main/docs/_static/MediumAPI-GettingStarted-Thumbnail.png\n        :target: https://www.youtube.com/watch?v=oc8TKG9EQfE\n        :alt: What is Medium API?\n        :align: center\n\n|\n\n.. image:: https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white\n        :target: https://twitter.com/medium_api\n        :alt: Twitter\n\n.. image:: https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white\n        :target: https://www.linkedin.com/company/medium-api\n        :alt: LinkedIn\n\n.. image:: https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white\n        :target: https://nishu-jain.medium.com\n        :alt: Medium\n\n|\n\nPython Wrapper on top of `Unofficial Medium API <http://hub.mediumapi.com>`_ to quickly extract data from Medium's website (https://medium.com).\n\nInstallation\n------------\n\nInstall from `PyPI <https://pypi.org/project/medium-api/>`_\n\n.. code-block:: console\n\n        $ pip install medium-api\n\n\n| For more information, see `Detailed Installation <https://medium-api.readthedocs.io/en/latest/installation.html>`_\n\nExample\n-------\n\nGetting a Medium user's information and fetching his articles.\n\n.. code-block:: python\n\n        from medium_api import Medium\n        \n        medium = Medium('YOUR_RAPIDAPI_KEY')\n\n        user = medium.user(username=\"nishu-jain\")\n\n        print(f'{user.fullname} has {user.followers_count} followers.')\n\n        user.fetch_articles()\n        for article in user.articles:\n                print(article.title)\n\n\nFor more examples, see `Usage <https://medium-api.readthedocs.io/en/latest/usage.html>`_ \n\nHow to get your RapidAPI Key\n----------------------------\n\n.. image:: https://img.youtube.com/vi/-MM1C6mb-mc/0.jpg\n        :align: center\n        :target: https://www.youtube.com/watch?v=-MM1C6mb-mc\n        :alt: How to get your RapidAPI Key (Subscribe to Medium API)\n\nSteps:\n\n        - Sign up on `RapidAPI Platform <https://rapidapi.com/auth/sign-up>`_\n        - Subscribe to our `Unofficial Medium-API <http://hub.mediumapi.com/pricing>`_\n        - Go to the API's *Endpoints* tab on the `RapidAPI Hub listing <http://hub.mediumapi.com>`_ and select the API key from the **X-RapidAPI-Key** dropdown under *Header Parameters* section.\n\nFor more details, see the following links:\n\n        - https://rapidapi.com/blog/api-glossary/api-key/\n        - https://docs.rapidapi.com/docs/keys\n\nFeatures\n--------\n\nExtract/Scrape/Fetch/Get:\n  \n    - Medium User information and User-written Articles\n    - Medium User's Followers and Following\n    - Medium Articles information\n    - Medium Article's Textual Content and Markdown\n    - Medium Article's Responses/Comments \n    - Medium Publications information\n    - Medium Publication's Articles\n    - Medium Publication's Newsletter Info\n    - Medium's Top Writers\n    - Medium's Topfeeds (Trending, Latest, All time best, best of year/month/week)\n    - Medium's LatestPosts (distributed articles)\n\n\nDocumentation\n-------------\n\nFull Documentation at https://medium-api.readthedocs.io\n\nOther Materials\n---------------\n\nMedium REST API:\n\n        - Swagger Documentation: https://docs.mediumapi.com\n\n.. Related Articles:\n\n..         - `Medium API - Documentation <https://medium.com/p/90a01549d8db>`_\n..         - `Medium API: Get Posts Using Python <https://medium.com/p/126d6d859ca8>`_\n..         - `Authenticate Medium Users Using Medium API <https://medium.com/p/ed7c1c1bcd66>`_\n..         - `Medium Notification Service <https://medium.com/p/ff6369938b63>`_\n..         - `How To List Hundreds of Niche Top Writers of Medium <https://medium.com/p/78e426bb7b39>`_\n..         - `How To Retrieve Medium Stories of a User Using API? <https://medium.com/p/fcdb1576558a>`_\n..         - `Medium API: Get Posts Using Node.js & Axios <https://medium.com/p/a43894efaeab>`_\n\n.. Miscellaneous Articles:\n\n..         - `Best Metric to Judge a Medium Article's Popularity <https://medium.com/p/cac577609bd4>`_\n..         - `How To Leverage Medium for Crypto-trading <https://medium.com/p/deedea890da1>`_\n\nLicense\n-------\n\nFree software: `MIT license <https://raw.githubusercontent.com/weeping-angel/medium-api/main/LICENSE>`_\n\nEULA: `Terms of Use <https://medium-api.readthedocs.io/en/latest/terms_of_use.html>`_\n\nCode of Conduct\n---------------\n\nIn the interest of fostering an open and welcoming environment, all contributors, maintainers \nand users are expected to abide by the Python code of conduct: https://www.python.org/psf/codeofconduct/\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python Wrapper on top of Medium API to quickly extract data from https://medium.com.",
    "version": "0.5.7",
    "project_urls": {
        "Homepage": "https://github.com/weeping-angel/medium-api"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "545a565e016d901cf37b563ef02cf07df4c0b73b9083c142253cc34f106f25b4",
                "md5": "23a65f21ef2c8c1f029a778b62300bef",
                "sha256": "0deef676b5f20b1b988f18082f9e7d6d7db7b6a3b9ba44bb058760e9554ba4f2"
            },
            "downloads": -1,
            "filename": "medium_api-0.5.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "23a65f21ef2c8c1f029a778b62300bef",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 27371,
            "upload_time": "2024-03-03T16:33:56",
            "upload_time_iso_8601": "2024-03-03T16:33:56.663315Z",
            "url": "https://files.pythonhosted.org/packages/54/5a/565e016d901cf37b563ef02cf07df4c0b73b9083c142253cc34f106f25b4/medium_api-0.5.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ce2955dec1effd38f3313fb7edfd516209046379d21766f8ac423440265b655f",
                "md5": "35e164cba4f8dbfc3e348622e2a26ea1",
                "sha256": "1cc75e56721ef9e71f9fc4eaf19793f48523f71884c896c1b7d22ec43ae0c3fd"
            },
            "downloads": -1,
            "filename": "medium-api-0.5.7.tar.gz",
            "has_sig": false,
            "md5_digest": "35e164cba4f8dbfc3e348622e2a26ea1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 1856358,
            "upload_time": "2024-03-03T16:34:01",
            "upload_time_iso_8601": "2024-03-03T16:34:01.825622Z",
            "url": "https://files.pythonhosted.org/packages/ce/29/55dec1effd38f3313fb7edfd516209046379d21766f8ac423440265b655f/medium-api-0.5.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-03 16:34:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "weeping-angel",
    "github_project": "medium-api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "medium-api"
}
        
Elapsed time: 0.20662s