pymediumapi

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

pymediumapi is a Python3 package to interact with the API of Medium

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Make sure to have python3, pip installed.

Installation

1. Get a free Integration token at https://medium.com/ and create an enviroment variable export MEDIUM_INTEGRATION_TOKEN=<your token>
2. Clone the repo

   git clone https://github.com/andregri/pymediumapi.git
   

3. Create a virtual environment and install requirements

   python3 -m venv venv
   source venv/bin/activate
   pip install -r requirements.txt
   

(back to top)

Usage

Example to authenticate and get a list of pubblications you subscribed:

import os
import pymediumapi


def main():
    client = pymediumapi.Client(os.environ.get('MEDIUM_INTEGRATION_TOKEN'))
    
    try:
        client.authenticate()
    except Exception as e:
        print("Failed authentication: " + str(e))
        quit()

    try:
        pubblications = client.get_pubblications()
    except Exception as e:
        print("Failed get pubblications: " + str(e))
        quit()

    if pubblications:
        pub_id = pubblications[0]["id"]
        
        try:
            contributors = client.get_contributors(pub_id)
        except Exception as e:
            print("Failed getting contributors: " + str(e))
        else:
            print(contributors)
    else:
        print("There are no pubblications")
        quit()


if __name__ == "__main__":
    main()

(back to top)

Roadmap

• [] Upload post under pubblications
• [] Upload images
• [] Upload the package

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Andrea Grillo - @AndreaGrillo96

Project Link: https://github.com/andregri/pymediumapi

(back to top)

Acknowledgments

• Medium API Docs

(back to top)