Introduced user_agent

claudiosanches · claudiosanches · commit fe1affbd2c9b · 2021-03-13T15:41:18.000-03:00
Closes woocommerce#53
diff --git a/README.rst b/README.rst
@@ -58,6 +58,8 @@ Options
 +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
 | ``query_string_auth`` | ``bool``    | no       | Force Basic Authentication as query string when ``True`` and using under HTTPS, default is ``False``  |
 +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
+| ``user_agent``        | ``string``  | no       | Set a custom User-Agent, default is ``WooCommerce-Python-REST-API/3.0.0``                             |
++-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
 | ``oauth_timestamp``   | ``integer`` | no       | Custom timestamp for requests made with oAuth1.0a                                                     |
 +-----------------------+-------------+----------+-------------------------------------------------------------------------------------------------------+
 | ``wp_api``            | ``bool``    | no       | Set to ``False`` in order to use the legacy WooCommerce API (deprecated)                              |
diff --git a/woocommerce/api.py b/woocommerce/api.py
@@ -34,6 +34,7 @@ def __init__(self, url, consumer_key, consumer_secret, **kwargs):
         self.timeout = kwargs.get("timeout", 5)
         self.verify_ssl = kwargs.get("verify_ssl", True)
         self.query_string_auth = kwargs.get("query_string_auth", False)
+        self.user_agent = kwargs.get("user_agent", f"WooCommerce-Python-REST-API/{__version__}")
 
     def __is_ssl(self):
         """ Check if url use HTTPS """
@@ -72,7 +73,7 @@ def __request(self, method, endpoint, data, params=None, **kwargs):
         url = self.__get_url(endpoint)
         auth = None
         headers = {
-            "user-agent": f"WooCommerce API {__version__}",
+            "user-agent": f"{self.user_agent}",
             "accept": "application/json"
         }
 
