manageritm-client 0.1.0

No project description provided

manageritm-client

Client to manage services on another system over a RESTful API

Getting Started

1. Install manageritm server.

   pip install manageritm gunicorn
   

2. Start manageritm server on port 8000.

   gunicorn --bind 0.0.0.0:8000 --workers 1 --log-level debug "manageritm.app:main()"
   

3. Install manageritm-client.

   pip install manageritm-client
   

4. In Python, create a client, start the mitmproxy service, stop the mitmproxy service

   import manageritm_client
   
   manageritm_addr = "localhost"
   manageritm_port = "8000"
   
   # create a manageritm client
   mc = manageritm_client.ManagerITMProxyClient(f'http://{manageritm_addr}:{manageritm_port}')
   proxy_details = mc.client()
   
   print(f"proxy port: {proxy_details['port']}")
   print(f"proxy webport: {proxy_details['webport']}")
   
   # start a proxy server
   mc.start()
   
   # set your application to use the proxy
   #  host: "localhost"
   #  port: f"{proxy_details['port']}"
   
   # do some work...
   
   # stop the proxy server
   mc.stop()
   

Local Development

1. Check out this repository
2. Create a virtual environment

   make pyenv
   

3. Install Python dependencies

   make install
   

4. Start the server

   make server
   

5. Start a client, in a Python interpreter:

   import manageritm_client
   
   manageritm_addr = "localhost"
   manageritm_port = "8000"
   
   # create a manageritm client
   mc = manageritm_client.ManagerITMProxyClient(f'http://{manageritm_addr}:{manageritm_port}')
   proxy_details = mc.client()
   
   print(f"proxy port: {proxy_details['port']}")
   print(f"proxy webport: {proxy_details['webport']}")
   
   # start a proxy server
   mc.start()
   

6. Navigate a web browser to http://localhost:<proxy webport> to watch the traffic
7. Configure a web browser to use the proxy port.
8. Stop the client

   # stop the proxy server
   mc.stop()
   

Helpful Commands

To build a package for the development version:

make all

To install a copy into your local python virtualenv

make install

To run the test cases:

make test