Merge pull request #48 from Ge0rg3/feature/readme-updates

Document New Features
Ge0rg3 · Oct 27, 2022 · a189ec2 · a189ec2
2 parents cbd7d11 + 3da350f
commit a189ec2
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ session = requests.Session()
 session.mount("https://site.com", gateway)
 
 # Send request (IP will be randomised)
-response = session.get("https://site.com/index.html")
+response = session.get("https://site.com/index.php", params={"theme": "light"})
 print(response.status_code)
 
 # Delete gateways
@@ -45,7 +45,7 @@ with ApiGateway("https://site.com") as g:
     session = requests.Session()
     session.mount("https://site.com", g)
 
-    response = session.get("https://site.com/index.html")
+    response = session.get("https://site.com/index.php")
     print(response.status_code)
 ```
 
@@ -90,10 +90,11 @@ gateway_2 = ApiGateway("https://www.google.com", regions=EXTRA_REGIONS, access_k
 An ApiGateway object must then be started using the `start` method.  
 **By default, if an ApiGateway already exists for the site, it will use the existing endpoint instead of creating a new one.**  
 This does not require any parameters, but accepts the following:
-| Name              | Description                                                   | Required    |
-| -----------       | -----------                                                   | ----------- |
-| force             | Create a new set of endpoints, even if some already exist.    | False       |
-| endpoints         | Array of pre-existing endpoints (i.e. from previous session). | False       |
+| Name                    | Description                                                           | Required    | Default
+| -----------             | -----------                                                           | ----------- | -----------
+| endpoints               | Array of pre-existing endpoints (i.e. from previous session).         | False       |
+| force                   | Create a new set of endpoints, even if some already exist.            | False       | False
+| require_manual_shutdown | Bool specifying whether Apigateways should persist `shutdown()` calls | False       | False 
 ```python
 # Starts new ApiGateway instances for site, or locates existing endpoints if they already exist.
 gateway_1.start()
@@ -145,6 +146,9 @@ endpoints = gateway_3.start(force=True)
 gateway_3.shutdown(endpoints[:3])
 ```
 
+**Please bear in mind that any gateways started with the `require_manual_shutdown` parameter set to `True` will not be deleted via the `shutdown` method, and must be deleted
+manually through either the AWS CLI or Website.**
+
 ## Credit
 The core gateway creation and organisation code was adapter from RhinoSecurityLabs' [IPRotate Burp Extension](https://github.com/RhinoSecurityLabs/IPRotate_Burp_Extension/).  
 The X-My-X-Forwarded-For header forwarding concept was originally conceptualised by [ustayready](https://twitter.com/ustayready) in his [fireprox](https://github.com/ustayready/fireprox) proxy.
diff --git a/setup.py b/setup.py
@@ -9,7 +9,7 @@
 # This call to setup() does all the work
 setup(
     name="requests-ip-rotator",
-    version="1.0.12",
+    version="1.0.14",
     description="Rotate through IPs in Python using AWS API Gateway.",
     long_description=README,
     long_description_content_type="text/markdown",