my-magento 2.0.0a1

Python Magento 2 REST API Wrapper

A Python package that wraps and extends the Magento 2 REST API

Explore the docs »

About MyMagento

What’s MyMagento?

MyMagento is a highly interconnected package that wraps and extends the Magento 2 REST API, providing a more intuitive and user-friendly interface to access and update your store.

…

MyMagento simplifies interaction with the Magento 2 REST API

If you’ve worked with the Magento 2 API, you’ll know that not all endpoints are created equally.

MyMagento aims to streamline your workflow, offering efficient API wrapper methods for a large number of API operations across multiple endpoints. It takes care of the small details so that you can stay focused on the more important aspects of managing your store.

…

Main Components

The Client

• Handles all interactions with the API, with support for multiple store views

• Accessible from all objects created by the package

The SearchQuery and Subclasses

• execute() predefined or custom search queries on any endpoint

• Supports simple and advanced searches using REST endpoints

The Model Subclasses

• Wrap all API responses in the package

• Provide additional endpoint-specific functionality for data updates and retrieval

…

Installation

Installing MyMagento

To install using pip:

pip install my-magento

Please note that MyMagento requires Python >= 3.10

Documentation

Full documentation can be found on ReadTheDocs

…

QuickStart: Login with MyMagento

Use the credentials of your Magento 2 admin account to initialize and authenticate() a Client

from magento import Client

>>> api = Client('website.com','username', 'password', login=False)
>>> api.authenticate()

|[ MyMagento | website_username ]|:  Authenticating username on website.com...
|[ MyMagento | website_username ]|:  Logged in to username

Once you initialize a Client, you have a few ways to start interacting with the api

…

Interacting with the API

For the rest of this README, please refer to the docs