Merge pull request #39 from Ostorlab/fix/update_references_to_docs

Update references to OXO

README.md

@@ -15,38 +15,38 @@ _Whatweb is a web technology fingerprinter capable of detecting CMS, blogging pl
 <img src="https://github.com/Ostorlab/agent_whatweb/blob/main/images/logo.png" alt="agent-whatweb" />
 </p>
 
-This repository is an implementation of [Ostorlab Agent](https://pypi.org/project/ostorlab/) for the [Whatweb Fingerprinter](https://github.com/urbanadventurer/WhatWeb.git).
+This repository is an implementation of [OXO Agent](https://pypi.org/project/ostorlab/) for the [Whatweb Fingerprinter](https://github.com/urbanadventurer/WhatWeb.git).
 
 ## Getting Started
 To perform your first scan, simply run the following command.
 ```shell
-ostorlab scan run --install --agent agent/ostorlab/whatweb domain-name tesla.com
+oxo scan run --install --agent agent/ostorlab/whatweb domain-name tesla.com
 ```
 
 This command will download and install `agent/ostorlab/whatweb`.
-For more information, please refer to the [Ostorlab Documentation](https://github.com/Ostorlab/ostorlab/blob/main/README.md)
+For more information, please refer to the [OXO Documentation](https://oxo.ostorlab.co/docs)
 
 
 ## Usage
 
-Agent Whatweb can be installed directly from the ostorlab agent store or built from this repository.
+Agent Whatweb can be installed directly from the oxo agent store or built from this repository.
 
- ### Install directly from ostorlab agent store
+ ### Install directly from oxo agent store
 
  ```shell
- ostorlab agent install agent/ostorlab/whatweb
+ oxo agent install agent/ostorlab/whatweb
  ```
 
 You can then run the agent with the following command:
 
 ```shell
-ostorlab scan run --agent agent/ostorlab/whatweb domain-name tesla.com
+oxo scan run --agent agent/ostorlab/whatweb domain-name tesla.com
 ```
 
 
 ### Build directly from the repository
 
- 1. To build the whatweb agent you need to have [ostorlab](https://pypi.org/project/ostorlab/) installed in your machine.  if you have already installed ostorlab, you can skip this step.
+ 1. To build the whatweb agent you need to have [oxo](https://pypi.org/project/ostorlab/) installed in your machine. If you have already installed oxo, you can skip this step.
 
 ```shell
 pip3 install ostorlab
@@ -58,21 +58,21 @@ pip3 install ostorlab
 git clone https://github.com/Ostorlab/agent_whatweb.git && cd agent_whatweb
 ```
 
- 3. Build the agent image using ostorlab cli.
+ 3. Build the agent image using oxo cli.
 
  ```shell
- ostortlab agent build --file=ostorlab.yaml
+ oxo agent build --file=ostorlab.yaml
  ```
  You can pass the optional flag `--organization` to specify your organisation. The organization is empty by default.
 
  1. Run the agent using on of the following commands:
 	 * If you did not specify an organization when building the image:
 	  ```shell
-	  ostorlab scan run --agent agent//whatweb domain-name tesla.com
+	  oxo scan run --agent agent//whatweb domain-name tesla.com
 	  ```
 	 * If you specified an organization when building the image:
 	  ```shell
-	  ostorlab scan run --agent agent/[ORGANIZATION]/whatweb domain-name tesla.com
+	  oxo scan run --agent agent/[ORGANIZATION]/whatweb domain-name tesla.com
 	  ```
 
 

agent/whatweb_agent.py

@@ -1,4 +1,5 @@
 """WhatWeb Agent: Agent responsible for finger-printing a website."""
+
 import abc
 import dataclasses
 import io

ostorlab.yaml

@@ -8,7 +8,7 @@ description: |
  ## Getting Started
  To perform your first scan, simply run the following command.
  ```shell
- ostorlab scan run --install --agent agent/ostorlab/whatweb domain-name tesla.com
+ oxo scan run --install --agent agent/ostorlab/whatweb domain-name tesla.com
  ```
 
  This command will download and install `agent/ostorlab/whatweb`.
@@ -17,24 +17,24 @@ description: |
 
  ## Usage
 
- Agent WhatWeb can be installed directly from the ostorlab agent store or built from this repository.
+ Agent WhatWeb can be installed directly from the oxo agent store or built from this repository.
 
-  ### Install directly from ostorlab agent store
+  ### Install directly from oxo agent store
 
   ```shell
-  ostorlab agent install agent/ostorlab/whatweb
+  oxo agent install agent/ostorlab/whatweb
   ```
 
  You can then run the agent with the following command:
 
  ```shell
- ostorlab scan run --agent agent/ostorlab/whatweb domain-name tesla.com
+ oxo scan run --agent agent/ostorlab/whatweb domain-name tesla.com
  ```
 
 
  ### Build directly from the repository
 
-  1. To build the whatweb agent you need to have [ostorlab](https://pypi.org/project/ostorlab/) installed in your machine.  if you have already installed ostorlab, you can skip this step.
+  1. To build the whatweb agent you need to have [oxo](https://pypi.org/project/ostorlab/) installed in your machine. If you have already installed oxo, you can skip this step.
 
  ```shell
  pip3 install ostorlab
@@ -46,21 +46,21 @@ description: |
  git clone https://github.com/Ostorlab/agent_whatweb.git && cd agent_whatweb
  ```
 
-  3. Build the agent image using ostorlab cli.
+  3. Build the agent image using oxo cli.
 
   ```shell
-  ostorlab agent build --file=ostorlab.yaml
+  oxo agent build --file=ostorlab.yaml
   ```
   You can pass the optional flag `--organization` to specify your organisation. The organization is empty by default.
 
   1. Run the agent using on of the following commands:
    * If you did not specify an organization when building the image:
     ```shell
-    ostorlab scan run --agent agent//whatweb domain-name tesla.com
+    oxo scan run --agent agent//whatweb domain-name tesla.com
     ```
    * If you specified an organization when building the image:
     ```shell
-    ostorlab scan run --agent agent/[ORGANIZATION]/whatweb domain-name tesla.com
+    oxo scan run --agent agent/[ORGANIZATION]/whatweb domain-name tesla.com
     ```
 
 

requirement.txt

@@ -1,2 +1,2 @@
 ostorlab[agent]
-rich
+rich

tests/conftest.py

@@ -1,4 +1,5 @@
 """Pytest fixture for the whatweb agent."""
+
 import pytest
 import json
 import pathlib

tests/whatweb_test.py

@@ -1,4 +1,5 @@
 """Unittests for whatweb agent."""
+
 import pathlib
 import subprocess
 import tempfile