-* |.`~.execute`|_ a search query on any endpoint
+* |.~.execute|_ a search query on any endpoint
* Intuitive interface for `Building Custom Search Queries `_
* All predefined methods retrieve data using only 1-2 API requests
@@ -255,7 +255,7 @@ Main Components
-🧠 The |.`~.Model`|_ Subclasses
+🧠 The |.~.Model|_ Subclasses
.. raw:: html
@@ -278,19 +278,19 @@ Available Endpoints
``MyMagento`` is compatible with every |api_endpoint|_
-Endpoints are wrapped with a |.`~.Model`|_ and |.`~.SearchQuery`|_ subclass as follows:
+Endpoints are wrapped with a |.~.Model|_ and |.~.SearchQuery|_ subclass as follows:
.. csv-table::
- :header: "**Endpoint**", "**Client Shortcut**", "|.`~.SearchQuery`|_ **Subclass**", "|.`~.Model`|_ **Subclass**"
+ :header: "**Endpoint**", "**Client Shortcut**", "|.~.SearchQuery|_ **Subclass**", "|.~.Model|_ **Subclass**"
- "``orders``", "|.`.Client.orders`|_", "|.`~.OrderSearch`|_", "|.`~.Order`|_"
- "``orders/items``", "|.`.Client.order_items`|_", "|.`~.OrderItemSearch`|_", "|.`~.OrderItem`|_"
- "``invoices``", "|.`.Client.invoices`|_", "|.`~.InvoiceSearch`|_", "|.`~.Invoice`|_"
- "``products``", "|.`.Client.products`|_", "|.`~.ProductSearch`|_", "|.`~.Product`|_"
- "``products/attributes``", "|.`.Client.product_attributes`|_", "|.`~.ProductAttributeSearch`|_", "|.`~.ProductAttribute`|_"
- "``categories``", "|.`.Client.categories`|_", "|.`~.CategorySearch`|_", "|.`~.Category`|_"
- "``endpoint``", "``Client.search('endpoint')``", "|.`~.SearchQuery`|_", "|.`~.APIResponse`|_"
+ "``orders``", "|..Client.orders|_", "|.~.OrderSearch|_", "|.~.Order|_"
+ "``orders/items``", "|..Client.order_items|_", "|.~.OrderItemSearch|_", "|.~.OrderItem|_"
+ "``invoices``", "|..Client.invoices|_", "|.~.InvoiceSearch|_", "|.~.Invoice|_"
+ "``products``", "|..Client.products|_", "|.~.ProductSearch|_", "|.~.Product|_"
+ "``products/attributes``", "|..Client.product_attributes|_", "|.~.ProductAttributeSearch|_", "|.~.ProductAttribute|_"
+ "``categories``", "|..Client.categories|_", "|.~.CategorySearch|_", "|.~.Category|_"
+ "``endpoint``", "``Client.search('endpoint')``", "|.~.SearchQuery|_", "|.~.APIResponse|_"
@@ -318,7 +318,7 @@ Full documentation can be found on `ReadTheDocs >> api = Client(domain, username, password, **kwargs)
-Option 2: Call |.`~.get_api`|_
+Option 2: Call |.~.get_api|_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: python
@@ -390,7 +390,7 @@ Option 2: Call |.`~.get_api`|_
>>> api = magento.get_api(**kwargs)
-|.`.get_api`|_ takes the same keyword arguments as the |.`~.Client`|_
+|..get_api|_ takes the same keyword arguments as the |.~.Client|_
* If the ``domain``, ``username``, or ``password`` are missing,
it will attempt to use the following environment variables:
@@ -406,10 +406,10 @@ Option 2: Call |.`~.get_api`|_
...
-Getting an |.`~.ACCESS_TOKEN`|_
+Getting an |.~.ACCESS_TOKEN|_
=======================================
-Unless you specify ``login=False``, the |.`~.Client`|_ will automatically call |.`~.authenticate`|_ once initialized:
+Unless you specify ``login=False``, the |.~.Client|_ will automatically call |.~.authenticate|_ once initialized:
.. code-block:: python
@@ -423,21 +423,21 @@ Unless you specify ``login=False``, the |.`~.Client`|_ will automatically call |
|
-Performing a |.`~.search`|_
+Performing a |.~.search|_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. |api_endpoints| replace:: API endpoint
.. _api_endpoints: https://adobe-commerce.redoc.ly/2.3.7-admin/
-The |.`.Client.search`|_ method lets you |.`~.execute`|_ a query on
+The |..Client.search|_ method lets you |.~.execute|_ a query on
any |api_endpoints|_
-It creates a |.`~.SearchQuery`|_ for the endpoint,
+It creates a |.~.SearchQuery|_ for the endpoint,
allowing you to retrieve data about
-* An individual item (ex. |.`~.SearchQuery.by_id`|_)
-* A list of items (ex. |.`~.SearchQuery.by_list`|_)
+* An individual item (ex. |.~.SearchQuery.by_id|_)
+* A list of items (ex. |.~.SearchQuery.by_list|_)
* Any search criteria you desire (see `Building Custom Search Queries `_)
@@ -445,7 +445,7 @@ allowing you to retrieve data about
...
-Example: |.`~.search`|_ an endpoint |.`~.by_id`|_
+Example: |.~.search|_ an endpoint |.~.by_id|_
=====================================================
.. code-block:: python
@@ -457,7 +457,7 @@ Example: |.`~.search`|_ an endpoint |.`~.by_id`|_
-Example: |.`~.search`|_ an endpoint |.`~.by_list`|_
+Example: |.~.search|_ an endpoint |.~.by_list|_
=======================================================
.. code-block:: python
@@ -470,23 +470,23 @@ Example: |.`~.search`|_ an endpoint |.`~.by_list`|_
...
-Search Results: The |.`~.Model`|_ Classes
+Search Results: The |.~.Model|_ Classes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. |the_models| replace:: the ``magento.models`` subpackage
.. _the_models: models.html
-The |.`~.SearchQuery.result`|_ of any |.`~.SearchQuery`|_ will be parsed and wrapped by a
-|.`~.Model`|_ class in |the_models|_.
+The |.~.SearchQuery.result|_ of any |.~.SearchQuery|_ will be parsed and wrapped by a
+|.~.Model|_ class in |the_models|_.
These classes make the API response data easier to work with.
They also provide endpoint-specific methods to update store data and search for related items.
-Example: Retrieving every |.`~.Order`|_ containing a |.`~.Product`|_
+Example: Retrieving every |.~.Order|_ containing a |.~.Product|_
==========================================================================
-Let's retrieve a |.`~.Product`|_ using |.`~.ProductSearch.by_sku`|_
+Let's retrieve a |.~.Product|_ using |.~.ProductSearch.by_sku|_
.. code-block:: python
@@ -510,7 +510,7 @@ We can search for orders containing this product in multiple ways:
-Example: Retrieving all |.`~.Product`|_\s and |.`~.Invoice`|_\s for a |.`~.Category`|_
+Example: Retrieving all |.~.Product|_\s and |.~.Invoice|_\s for a |.~.Category|_
===============================================================================================
.. code-block:: python
@@ -524,7 +524,7 @@ Example: Retrieving all |.`~.Product`|_\s and |.`~.Invoice`|_\s for a |.`~.Categ
-Example: Updating the Thumbnail |.`~.MediaEntry`|_ of a |.`~.Product`|_
+Example: Updating the Thumbnail |.~.MediaEntry|_ of a |.~.Product|_
=============================================================================
.. code-block:: python
@@ -556,8 +556,8 @@ Example: Updating the Thumbnail |.`~.MediaEntry`|_ of a |.`~.Product`|_
If you have multiple store views, a ``store_code`` can be specified when
retrieving/updating data
-* The |.`.Client.scope`|_ is used by default - simply change it to switch store |.`~.views`|_
-* Passing the ``scope`` keyword argument to |.`.Client.url_for`|_, |.`.Model.refresh`|_,
+* The |..Client.scope|_ is used by default - simply change it to switch store |.~.views|_
+* Passing the ``scope`` keyword argument to |..Client.url_for|_, |..Model.refresh|_,
and some Model update methods will temporarily override the Client scope
.. raw:: html
@@ -577,8 +577,9 @@ Building Custom Search Queries
In addition to the predefined methods, you can also build your own queries
-* Simply |.`~.add_criteria`|_, |.`~.restrict_fields`|_, and |.`~.execute`|_ the search
-* The |.`~.since`|_ and |.`~.until`|_ methods allow you to further filter your query by date
+* Simply |.~.add_criteria|_, |.~.restrict_fields|_, and |.~.execute|_ the search
+* The |.~.since|_ and |.~.until|_ methods allow you to further filter your query by date
+
@@ -620,14 +621,14 @@ In addition to the predefined methods, you can also build your own queries
Making Authorized Requests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The |.`~.Client`|_ can be used to generate the |.`~.url_for`|_ any API endpoint,
-including a store |.`~.scope`|_.
+The |.~.Client|_ can be used to generate the |.~.url_for|_ any API endpoint,
+including a store |.~.scope|_.
You can use this URL to make an authorized
-|.`~.get`|_, |.`~.post`|_, |.`~.put`|_, or |.`~.delete`|_ request.
+|.~.get|_, |.~.post|_, |.~.put|_, or |.~.delete|_ request.
-Example: Making a |.`~.get`|_ Request
+Example: Making a |.~.get|_ Request
=============================================
.. code-block:: python
@@ -640,6 +641,7 @@ Example: Making a |.`~.get`|_ Request
{'adjustment': 1.5, 'adjustment_negative': 0, 'adjustment_positive': 1.5, 'base_adjustment': 1.5, ... }
+
.. raw:: html
@@ -653,8 +655,8 @@ Example: Making a |.`~.get`|_ Request
|
-A |.`~.search`|_ is simpler than making |.`~.get`|_ requests, as the result will
-be wrapped by |.`~.APIResponse`|_ or other |.`~.Model`|_
+A |.~.search|_ is simpler than making |.~.get|_ requests, as the result will
+be wrapped by |.~.APIResponse|_ or other |.~.Model|_
.. code-block:: python
@@ -673,4 +675,3 @@ be wrapped by |.`~.APIResponse`|_ or other |.`~.Model`|_
-
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 60b1e51..c2ba70f 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -4,5 +4,5 @@ docutils<0.17
myst-nb>=0.17.1
sphinx-sitemap>=2.5.0
sphinx-github-style>=1.0.2
-sphinx-readme>=0.2.1
+sphinx-readme>=1.1.0
sphinx-inlinecode
diff --git a/docs/source/interact-with-api.rst b/docs/source/interact-with-api.rst
index a898711..206d976 100644
--- a/docs/source/interact-with-api.rst
+++ b/docs/source/interact-with-api.rst
@@ -154,20 +154,19 @@ In addition to the predefined methods, you can also build your own queries
* The :meth:`~.since` and :meth:`~.until` methods allow you to further filter your query by date
-.. only:: readme or html
- .. admonition:: Example: Retrieve Orders Over $50 Placed Since the Start of 2023
- :class: example
+.. admonition:: Example: Retrieve Orders Over $50 Placed Since the Start of 2023
+ :class: example
- .. code-block:: python
+ .. code-block:: python
- >>> api.orders.add_criteria(
- ... field="grand_total",
- ... value="50",
- ... condition="gt"
- ... ).since("2023-01-01").execute()
+ >>> api.orders.add_criteria(
+ ... field="grand_total",
+ ... value="50",
+ ... condition="gt"
+ ... ).since("2023-01-01").execute()
- [, ...]
+ [, ...]
.. only:: pypi
@@ -211,39 +210,20 @@ Example: Making a :meth:`~.get` Request
{'adjustment': 1.5, 'adjustment_negative': 0, 'adjustment_positive': 1.5, 'base_adjustment': 1.5, ... }
-.. only:: readme or html
-
- .. note:: A :meth:`~.search` is simpler than making :meth:`~.get` requests, as the result will
- be wrapped by :class:`~.APIResponse` or other :class:`~.Model`
-
- .. code-block:: python
- # Retrieve credit memo with id 7 using a search
- >>> memo = api.search("creditmemo").by_id(7)
- >>> print(memo.data)
- >>> print(memo)
-
- {'adjustment': 1.5, 'adjustment_negative': 0, 'adjustment_positive': 1.5, 'base_adjustment': 1.5, ... }
-
+.. note:: A :meth:`~.search` is simpler than making :meth:`~.get` requests, as the result will
+ be wrapped by :class:`~.APIResponse` or other :class:`~.Model`
-.. only:: pypi
-
- .. list-table::
- :header-rows: 1
-
- * - 📝 Note
- * - A :meth:`~.search` is simpler than making :meth:`~.get` requests, as the result will
- be wrapped by :class:`~.APIResponse` or other :class:`~.Model`
+ .. code-block:: python
- .. code-block:: python
+ # Retrieve credit memo with id 7 using a search
+ >>> memo = api.search("creditmemo").by_id(7)
+ >>> print(memo.data)
+ >>> print(memo)
- # Retrieve credit memo with id 7 using a search
- >>> memo = api.search("creditmemo").by_id(7)
- >>> print(memo.data)
- >>> print(memo)
+ {'adjustment': 1.5, 'adjustment_negative': 0, 'adjustment_positive': 1.5, 'base_adjustment': 1.5, ... }
+
- {'adjustment': 1.5, 'adjustment_negative': 0, 'adjustment_positive': 1.5, 'base_adjustment': 1.5, ... }
-
.. only:: html
| | |