Better docs, stability, formatting; use ruff

Author: CoderJoshDK

README.md

@@ -1,27 +1,31 @@
 [![Python](https://img.shields.io/badge/Python->=3.8-%23FFD140)](https://www.python.org/)
 [![PyPI](https://img.shields.io/pypi/v/WIOpy)](https://pypi.org/project/WIOpy/)
-[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/CoderJoshDK/WIOpy?include_prereleases)](https://github.com/CoderJoshDK/WIOpy)
-[![GitHub issues](https://img.shields.io/github/issues/CoderJoshDK/WIOpy)](https://github.com/CoderJoshDK/WIOpy/issues)
+[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/CoderJoshDK/WIOpy?include_prereleases)](https://github.com/CoderJoshDK/WIOpy) [![GitHub issues](https://img.shields.io/github/issues/CoderJoshDK/WIOpy)](https://github.com/CoderJoshDK/WIOpy/issues)
 [![GitHub Repo stars](https://img.shields.io/github/stars/CoderJoshDK/WIOpy?style=social)](https://github.com/CoderJoshDK/WIOpy)
 
 # WalmartIO Python Wrapper - WIOpy
 
-A python wrapper for the Walmart io API. Only supports the Affiliate API for now. The project is open to contributions 
+A python wrapper for the Walmart io API. Only supports the Affiliate API for now. The project is open to contributions
 
 ## Getting it
 
 To download WIOpy, either fork this github repo or simply use Pypi via pip.
+
 ```sh
-$ pip install WIOpy
-```  
+pip install WIOpy
+```
+
 To upgrade the package simply run  
+
 ```sh
-$ pip install WIOpy --upgrade
-```  
+pip install WIOpy --upgrade
+```
 
 ## How to use  
-An example of creating a WIOpy connection   
+
+An example of creating a WIOpy connection
 One important note is that you need to pass in the private key file *path*.  
+
 ```py
 from wiopy import WalmartIO
 walmart_io = WalmartIO(
@@ -32,129 +36,157 @@ walmart_io = WalmartIO(
 )
 data = walmart_io.product_lookup('33093101')[0]
 ```
+
 WIOpy also supports asynchronous calls. To use, everything will be the same but you must await a call and the constructed object is different.
+
 ```py
 from wiopy import AsyncWalmartIO
 async_walmart_io = AsyncWalmartIO(...)
 data = await async_walmart_io.product_lookup('33093101')[0]
 ```
 
 ## Response Examples
+
 When making a call to the API, an object will be returned. That object is an object version of returned JSON.  
 There are two ways to get info from the object:
- - `data.name`  
- - `data['name']`  
+
+- `data.name`  
+- `data['name']`  
 An example of a returned object and one that is not (review/search are variables returned):
- - `review.reviewStatistics.averageOverallRating` # Nested call
- - `search.facets` # Gives back a dict that can now be used like a dict and not object  
+- `review.reviewStatistics.averageOverallRating` # Nested call
+- `search.facets` # Gives back a dict that can now be used like a dict and not object  
 Some attributes will return a dict and not an object due to a lack of documentation from Walmart.  
 When getting an attribute from a `WalmartResponse`, it will return either `response` or `None`\. But trying to get an attribute of `None` will still raise an error.
 [Extra details on calls and responses](walmart.io/docs). However, the docs are inconsistent and lack typical practices such as response schema. That is why something like the search facets response is missing because the docs show it is in the response but not what type of data it will contain.  
 While there may be a response missing or a response not being converted to an object, please check [WalmartResponse](./wiopy/WalmartResponse.py) to get an idea of what a response will return. Some properties are not always present in a response.  
 
-
 ## Examples of calls
 
 ### [Catalog Product](https://walmart.io/docs/affiliate/paginated-items)
+
 Catalog Product API allows a developer to retrieve the products catalog in a paginated fashion. Catalog can be filtered by category, brand and/or any special offers like rollback, clearance etc.
+
 ```py
 data = walmart_io.catalog_product(category='3944', maxId='8342714')
 ```
-A catalog response contains category, format, nextPage, totalPages, and a list of items
 
+A catalog response contains category, format, nextPage, totalPages, and a list of items
 
 ### [Post Browsed Products](https://walmart.io/docs/affiliate/post-browsed-products)
+
 The post browsed products API allows you to recommend products to someone based on their product viewing history.
+
 ```py
 data = walmart_io.post_browsed_products('54518466')
 ```
-Response gives top 10 relevant items to the given id
 
+Response gives top 10 relevant items to the given id
 
 ### [Product lookup](https://walmart.io/docs/affiliate/product-lookup)
-There are two ways to lookup a product   
+
+There are two ways to lookup a product
 The first is to pass a single string in
+
 ```py
 data = walmart_io.product_lookup('33093101')[0]
 ```
+
 or you can pass a list of strings
+
 ```py
 data = walmart_io.product_lookup('33093101, 54518466, 516833054')
 data = walmart_io.product_lookup(['33093101', '54518466', '516833054'])
 ```
-Remember: product_lookup always returns a list of [WalmartProducts](https://walmart.io/docs/affiliate/item_response_groups)  
 
+Remember: product_lookup always returns a list of [WalmartProducts](https://walmart.io/docs/affiliate/item_response_groups)  
 
 ### [Bulk product lookup](https://walmart.io/docs/affiliate/product-lookup)
+
 `bulk_product_lookup` is similar to `product_lookup` however, the bulk version does not raise errors and it is a generator.  
 Items are passed in as chunks of max size 20. If an error occurs on that call, the same call will be retried based on the given amount. If error still occurs, all items will be lost. But the entire call will not be lost.  
+
 ```py
 data = walmart_io.bulk_product_lookup('33093101, 54518466, 516833054', amount=1, retries=3)
 for items in data:
     for item in items:
         print(item)
 ```
+
 Response gives generator of [WalmartProducts](https://walmart.io/docs/affiliate/item_response_groups)  
 If you are unfamiliar with async generators; to properly call the async version:
+
 ```py
 data = async_walmart_io.bulk_product_lookup('33093101, 54518466, 516833054')
 async for items in data:
     ...
 ```
 
-
 ### [Product Recommendation](https://walmart.io/docs/affiliate/product-recommendation)
+
 Get recommendations based on a given product id
+
 ```py
 data = walmart_io.product_recommendation('54518466')
 ```
-Response gives a list of related products
 
+Response gives a list of related products
 
 ### [Reviews](https://walmart.io/docs/affiliate/reviews)
+
 The Reviews API gives you access to the extensive item reviews on Walmart that have been written by the users of Walmart.com
+
 ```py
 data = walmart_io.reviews('33093101')
 ```
-Response gives review data
 
+Response gives review data
 
 ### [Search](https://walmart.io/docs/affiliate/search)
+
 Search API allows text search on the Walmart.com catalogue and returns matching items available for sale online.
+
 ```py
 # Search for tv within electronics and sort by increasing price:
 data = walmart_io.search('tv', categoryId='3944', sort='price', order='ascending')
 ```
+
 You can also add facets to your search
+
 ```py
 data = walmart_io.search('tv', filter='brand:Samsung')
 ```
-The search response gives back a list of products and some meta data. It returns a `facets` element but there is no detail on the API about what it could return. It is a list of some unknown type
 
+The search response gives back a list of products and some meta data. It returns a `facets` element but there is no detail on the API about what it could return. It is a list of some unknown type
 
 ### [Stores](https://walmart.io/docs/affiliate/stores)
+
 The API can return a list of closest stores near a specified location. Either zip code or lon/lat  
+
 ```py
 data = walmart_io.stores(lat=29.735577, lon=-95.511747)
 ```
 
-
 ### [Taxonomy](https://walmart.io/docs/affiliate/taxonomy)
+
 The taxonomy service exposes the taxonomy used to categorize items on Walmart.com.  
 Details about params is missing from docs
+
 ```py
 data = walmart_io.taxonomy()
 ```
 
-
 ### [Trending Items](https://walmart.io/docs/affiliate/trending-items)
+
 The Trending Items API is designed to give the information on what is bestselling on Walmart.com right now.
+
 ```py
 data = walmart_io.trending()
 ```
 
 ## Logging
+
 WIOpy supports logging via the logging module. Configuration of the logging module can be as simple as:
+
 ```py
 import logging
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WIOpy"
-version = "1.0.0"
+version = "1.1.0"
 description = "A Python wrapper for the Walmart IO API"
 readme = { file = "README.md", content-type = "text/markdown" }
 license = { file = "LICENSE" }
@@ -37,17 +37,22 @@ classifiers = [
     "Typing :: Typed",
 ]
 
+[project.optional-dependencies]
+dev = ["ruff", "pre-commit"]
+
 [project.urls]
 "Homepage" = "https://github.com/CoderJoshDK/WIOpy"
 "Bug Reports" = "https://github.com/CoderJoshDK/WIOpy/issues"
 "Source" = "https://github.com/CoderJoshDK/WIOpy"
 
-
-[tool.black]
+[tool.ruff]
 line-length = 100
+fix = true
+target-version = "py38"
+
+unfixable = ["F841"]
+ignore = ["PLR0913", "ISC001", "PLR2004"]
 
-[tool.isort]
-profile = "black"
-combine_as_imports = true
-combine_star = true
-line_length = 100
+[tool.ruff.lint]
+select = ["E", "F", "B", "W", "Q", "A", "I", "D",
+    "UP", "ASYNC", "FA", "ISC", "RET", "SIM", "ARG", "PL", "RUF"]