assemblyline-v4-service 4.5.1.dev427__py3-none-any.whl → 4.5.1.dev434__py3-none-any.whl

assemblyline_v4_service/VERSION

@@ -1 +1 @@
-4.5.1.dev427
+4.5.1.dev434

assemblyline_v4_service/common/base.py

@@ -26,7 +26,6 @@ from assemblyline_v4_service.common.task import Task
 # Ignore all other warnings that a service's libraries can generate
 warnings.filterwarnings("ignore")
 
-LOG_LEVEL = logging.getLevelName(os.environ.get("LOG_LEVEL", "INFO"))
 UPDATES_DIR = os.environ.get('UPDATES_DIR', '/updates')
 UPDATES_CA = os.environ.get('UPDATES_CA', '/etc/assemblyline/ssl/al_root-ca.crt')
 PRIVILEGED = os.environ.get('PRIVILEGED', 'false') == 'true'
@@ -56,7 +55,7 @@ class ServiceBase:
 
         self.name = self.service_attributes.name.lower()
         # Initialize logging for the service
-        log.init_logging(f'{self.service_attributes.name}', log_level=LOG_LEVEL)
+        log.init_logging(f'{self.service_attributes.name}')
         self.log = logging.getLogger(f'assemblyline.service.{self.name}')
 
         # Replace warning/error methods with our own patched version

assemblyline_v4_service/dev/run_service_once.py

@@ -97,7 +97,6 @@ class RunService:
             min_classification=forge.get_classification().UNRESTRICTED,
             max_files=501,  # TODO: get the actual value
             ttl=3600
-
         ))
 
         LOG.info(f"Starting task with SID: {service_task.sid}")

assemblyline_v4_service/healthz.py

@@ -32,4 +32,4 @@ def perform_check():
 
 
 if __name__ == '__main__':
-    perform_check()
+    perform_check()

assemblyline_v4_service/run_privileged_service.py

@@ -20,7 +20,7 @@ from assemblyline.odm.messages.service_heartbeat import Metrics
 from assemblyline.odm.messages.task import Task as ServiceTask
 from assemblyline_core.tasking_client import TaskingClient
 from assemblyline_core.server_base import ServerBase
-from assemblyline_v4_service.common.base import LOG_LEVEL, is_recoverable_runtime_error
+from assemblyline_v4_service.common.base import is_recoverable_runtime_error
 
 SERVICE_PATH = os.environ['SERVICE_PATH']
 SERVICE_TAG = os.environ.get("SERVICE_TAG", f"{FRAMEWORK_VERSION}.{SYSTEM_VERSION}.{BUILD_MINOR}.dev0").encode("utf-8")
@@ -74,9 +74,7 @@ class RunPrivilegedService(ServerBase):
 
         self.status = STATUSES.INITIALIZING
         self.metric_factory = None
-
-        self.log.setLevel(LOG_LEVEL)
-
+        
     def _load_manifest(self):
         bio = BytesIO()
         with open(SERVICE_MANIFEST, "rb") as srv_manifest:

assemblyline_v4_service/run_service.py

@@ -8,7 +8,6 @@ from assemblyline.common.version import FRAMEWORK_VERSION, SYSTEM_VERSION, BUILD
 from assemblyline.odm.messages.task import Task as ServiceTask
 from assemblyline_core.server_base import ServerBase
 from assemblyline_v4_service.common import helper
-from assemblyline_v4_service.common.base import LOG_LEVEL
 
 SERVICE_PATH = os.environ['SERVICE_PATH']
 SERVICE_NAME = SERVICE_PATH.split(".")[-1].lower()
@@ -39,8 +38,6 @@ class RunService(ServerBase):
         self.done_fifo = None
         self.tasking_dir = os.environ.get('TASKING_DIR', tempfile.gettempdir())
 
-        self.log.setLevel(LOG_LEVEL)
-
     def try_run(self):
         try:
             self.service_class = load_module_by_path(SERVICE_PATH)

assemblyline_v4_service-4.5.1.dev434.dist-info/METADATA

@@ -0,0 +1,107 @@
+Metadata-Version: 2.2
+Name: assemblyline-v4-service
+Version: 4.5.1.dev434
+Summary: Assemblyline 4 - Service base
+Home-page: https://github.com/CybercentreCanada/assemblyline-v4-service/
+Author: CCCS Assemblyline development team
+Author-email: assemblyline@cyber.gc.ca
+License: MIT
+Keywords: assemblyline automated malware analysis gc canada cse-cst cse cst cyber cccs
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+License-File: LICENCE.md
+Requires-Dist: assemblyline
+Requires-Dist: assemblyline-core
+Requires-Dist: cart
+Requires-Dist: fuzzywuzzy
+Requires-Dist: pefile
+Requires-Dist: pillow!=10.1.0,!=10.2.0
+Requires-Dist: python-Levenshtein
+Requires-Dist: regex
+Provides-Extra: updater
+Requires-Dist: gunicorn[gevent]; extra == "updater"
+Requires-Dist: flask; extra == "updater"
+Requires-Dist: gitpython; extra == "updater"
+Requires-Dist: git-remote-codecommit; extra == "updater"
+Requires-Dist: psutil; extra == "updater"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+[![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/GUAy9wErNu)
+[![](https://img.shields.io/discord/908084610158714900)](https://discord.gg/GUAy9wErNu)
+[![Static Badge](https://img.shields.io/badge/github-assemblyline-blue?logo=github)](https://github.com/CybercentreCanada/assemblyline)
+[![Static Badge](https://img.shields.io/badge/github-assemblyline--v4--service-blue?logo=github)](https://github.com/CybercentreCanada/assemblyline-v4-service)
+[![GitHub Issues or Pull Requests by label](https://img.shields.io/github/issues/CybercentreCanada/assemblyline/service-base)](https://github.com/CybercentreCanada/assemblyline/issues?q=is:issue+is:open+label:service-base)
+[![License](https://img.shields.io/github/license/CybercentreCanada/assemblyline-v4-service)](./LICENCE.md)
+
+# Assemblyline 4 - Service Base
+
+This repository provides the base service functionality for Assemblyline 4 services.
+
+## Image variants and tags
+
+| **Tag Type** | **Description**                                                                                  |      **Example Tag**       |
+| :----------: | :----------------------------------------------------------------------------------------------- | :------------------------: |
+|    latest    | The most recent build (can be unstable).                                                         |          `latest`          |
+|  build_type  | The type of build used. `dev` is the latest unstable build. `stable` is the latest stable build. |     `stable` or `dev`      |
+|    series    | Complete build details, including version and build type: `version.buildType`.                   | `4.5.stable`, `4.5.1.dev3` |
+
+## Creating a new Assemblyline service
+
+You can create a new Assemblyline service by using this [template](https://github.com/CybercentreCanada/assemblyline-service-template):
+
+```bash
+apt install jq
+pip install git+https://github.com/CybercentreCanada/assemblyline-service-template.git
+cruft create https://github.com/CybercentreCanada/assemblyline-service-template.git
+```
+
+## Documentation
+
+For more information about service development for Assemblyline, follow this [guide](https://cybercentrecanada.github.io/assemblyline4_docs/developer_manual/services/developing_an_assemblyline_service/).
+
+---
+
+# Assemblyline 4 - Service Base
+
+Ce référentiel fournit les fonctionnalités de base des services Assemblyline 4.
+
+## Créer un nouveau service Assemblyline
+
+Vous pouvez créer un nouveau service Assemblyline en utilisant ce [template](https://github.com/CybercentreCanada/assemblyline-service-template).
+
+```bash
+apt install jq
+pip install git+https://github.com/CybercentreCanada/assemblyline-service-template.git
+cruft create https://github.com/CybercentreCanada/assemblyline-service-template.git
+```
+
+## Variantes et étiquettes d'image
+
+| **Type d'étiquette** | **Description**                                                                                                  |  **Exemple d'étiquette**   |
+| :------------------: | :--------------------------------------------------------------------------------------------------------------- | :------------------------: |
+|       dernière       | La version la plus récente (peut être instable).                                                                 |          `latest`          |
+|      build_type      | Le type de compilation utilisé. `dev` est la dernière version instable. `stable` est la dernière version stable. |     `stable` or `dev`      |
+|        séries        | Le détail de compilation utilisé, incluant la version et le type de compilation : `version.buildType`.           | `4.5.stable`, `4.5.1.dev3` |
+
+## Documentation
+
+Pour plus d'informations sur le développement des services pour Assemblyline, suivez ce [guide](https://cybercentrecanada.github.io/assemblyline4_docs/developer_manual/services/developing_an_assemblyline_service/).

{assemblyline_v4_service-4.5.1.dev427.dist-info → assemblyline_v4_service-4.5.1.dev434.dist-info}/RECORD

@@ -1,12 +1,12 @@
-assemblyline_v4_service/VERSION,sha256=BKrIbfIdTfDe8JYGKFYKJjs3iA5Hrzo737huwcNlfQk,13
+assemblyline_v4_service/VERSION,sha256=6S--CZUkgz9LjHARP52le3F-9nrbvyx_UWKyEtiUO8k,13
 assemblyline_v4_service/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-assemblyline_v4_service/healthz.py,sha256=sS1cFkDLw8hUPMpj7tbHXFv8ZmHcazrwZ0l6oQDwwkQ,1575
+assemblyline_v4_service/healthz.py,sha256=3QGBg0EZuXC6UN411HFwpLNEop9UvS9feFhvBUTP-k4,1576
 assemblyline_v4_service/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-assemblyline_v4_service/run_privileged_service.py,sha256=ipCjdB_PZXt85Hmu9r9q7QjKXI8Y6iF-w6Aa4PMn9S4,14576
-assemblyline_v4_service/run_service.py,sha256=NiFX52NfsbBQY6E3nrjoB3e2XxIlwFcQpYYY-rADIk4,5996
+assemblyline_v4_service/run_privileged_service.py,sha256=IRqhG5ULKjOuy7-W4Fm_R0xb3HPhBlF5iHwNyRBHIME,14535
+assemblyline_v4_service/run_service.py,sha256=XfdABk3hEZsIw31tmFcJc-FbcxvBF9tiDIlg9oHCtZA,5900
 assemblyline_v4_service/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 assemblyline_v4_service/common/api.py,sha256=Xzp8j4HCCfjPvNSGKiZl5ttH2_Itg47cjlH0NXNtth0,6849
-assemblyline_v4_service/common/base.py,sha256=4rnK_183qsSfkRkuVp_0wy-haW49umx4jJIC0OalGDM,14218
+assemblyline_v4_service/common/base.py,sha256=psivTxiOeN2jqL3G3I26oY9JFK-qPuwrg5y_y_d7xYs,14127
 assemblyline_v4_service/common/helper.py,sha256=xs9quuf-M1JOdKieBqOmWaOece0CtzXFhhe85xQYmuY,3289
 assemblyline_v4_service/common/ocr.py,sha256=3fV0PyY3oui_ucAM9dkolP0VRYKACKJuGY4M64DudIE,8841
 assemblyline_v4_service/common/ontology_helper.py,sha256=9Ad81qbddg_pRMupT8o_KzxbKgpodaRqpc3mPoEKLtw,8494
@@ -15,7 +15,7 @@ assemblyline_v4_service/common/result.py,sha256=9AqM6qCYiia_Bpyn_fBFhzNQMcqJbtFS
 assemblyline_v4_service/common/task.py,sha256=dJsvRpW0x88CCF_LW6w87jQ_UKTVaOs2Gb117IDNiU8,14233
 assemblyline_v4_service/common/utils.py,sha256=k2__d-V5LjB6o2IKbjVe7tJWKcKuUHto5TyT5oKhIa0,3890
 assemblyline_v4_service/dev/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-assemblyline_v4_service/dev/run_service_once.py,sha256=BicBzWVArRzGf8Qxi-_NfP-Cgy9J_1gEQpQb3HBPGTg,10151
+assemblyline_v4_service/dev/run_service_once.py,sha256=1sdxkRBI7x9Sht8EVCTMIW3MgSxIeV6Ufw77Wx9Vf20,10150
 assemblyline_v4_service/updater/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 assemblyline_v4_service/updater/__main__.py,sha256=9Os-u8Tf7MD73JSrUSPmOaErTgfvesNLiEeszU4ujXA,133
 assemblyline_v4_service/updater/app.py,sha256=Mtmx4bkXfP4nFqqa5q15jW8QIXr4JK84lCovxAVyvPs,3317
@@ -38,8 +38,8 @@ test/test_common/test_request.py,sha256=Ceyds8BNO1O0f1kH1VEb84faJcaupvSjVKIrGdHe
 test/test_common/test_result.py,sha256=6BiOKxEPrKBjOY44jv3TY-yiXm0qI1ok_CZBnjP9TM4,45447
 test/test_common/test_task.py,sha256=P44mNcSe-3tJgDk9ppN3KbM7oN4LBVIuhONG-Gveh74,19007
 test/test_common/test_utils.py,sha256=TbnBxqpS_ZC5ptXR9XJX3xtbItD0mTbtiBxxdyP8J5k,5904
-assemblyline_v4_service-4.5.1.dev427.dist-info/LICENCE.md,sha256=NSkYo9EH8h5oOkzg4VhjAHF4339MqPP2cQ8msTPgl-c,1396
-assemblyline_v4_service-4.5.1.dev427.dist-info/METADATA,sha256=1s08W4hjyu66tnwXtfOd7JiQhFfIAW5ZlziTnJoacug,9724
-assemblyline_v4_service-4.5.1.dev427.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-assemblyline_v4_service-4.5.1.dev427.dist-info/top_level.txt,sha256=LpTOEaVCatkrvbVq3EZseMSIa2PQZU-2rhuO_FTpZgY,29
-assemblyline_v4_service-4.5.1.dev427.dist-info/RECORD,,
+assemblyline_v4_service-4.5.1.dev434.dist-info/LICENCE.md,sha256=NSkYo9EH8h5oOkzg4VhjAHF4339MqPP2cQ8msTPgl-c,1396
+assemblyline_v4_service-4.5.1.dev434.dist-info/METADATA,sha256=9C5IhkY-GTNXcNwbTlinUj44dlgPaiXfsP_B7w8zt9g,5603
+assemblyline_v4_service-4.5.1.dev434.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+assemblyline_v4_service-4.5.1.dev434.dist-info/top_level.txt,sha256=LpTOEaVCatkrvbVq3EZseMSIa2PQZU-2rhuO_FTpZgY,29
+assemblyline_v4_service-4.5.1.dev434.dist-info/RECORD,,

assemblyline_v4_service-4.5.1.dev427.dist-info/METADATA

@@ -1,276 +0,0 @@
-Metadata-Version: 2.2
-Name: assemblyline-v4-service
-Version: 4.5.1.dev427
-Summary: Assemblyline 4 - Service base
-Home-page: https://github.com/CybercentreCanada/assemblyline-v4-service/
-Author: CCCS Assemblyline development team
-Author-email: assemblyline@cyber.gc.ca
-License: MIT
-Keywords: assemblyline automated malware analysis gc canada cse-cst cse cst cyber cccs
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Description-Content-Type: text/markdown
-License-File: LICENCE.md
-Requires-Dist: assemblyline
-Requires-Dist: assemblyline-core
-Requires-Dist: cart
-Requires-Dist: fuzzywuzzy
-Requires-Dist: pefile
-Requires-Dist: pillow!=10.1.0,!=10.2.0
-Requires-Dist: python-Levenshtein
-Requires-Dist: regex
-Provides-Extra: updater
-Requires-Dist: gunicorn[gevent]; extra == "updater"
-Requires-Dist: flask; extra == "updater"
-Requires-Dist: gitpython; extra == "updater"
-Requires-Dist: git-remote-codecommit; extra == "updater"
-Requires-Dist: psutil; extra == "updater"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: summary
-
-# Assemblyline 4 - Service Base
-
-This repository provides the base service functionality for Assemblyline 4 services.
-
-## Creating a new Assemblyline service
-
-### Service file structure
-
-An Assemblyline service has the following file structure:
-
-```text
-assemblyline-service-<service name>
-│
-├── Dockerfile
-├── <service name>.py
-└── service_manifest.yml
-```
-
-This is overview of what each of these does:
-
-- `Dockerfile` ─ Build file for the service container, see _Dockerfile_ section below for more details
-- `<service name>.py` ─ Contains main service code
-- `service_manifest.yml` ─ Service definition file, see _Service manifest_ section below for more details
-
-
-### Service manifest
-
-Every service must have a `service_manifest.yml` file in its root directory. The manifest file presents essential information about the service to the Assemblyline core system, information the system must have before it can run the service.
-
-The diagram below shows all the elements that the manifest file can contain, including a brief description of each.
-
-```yaml
-# Name of the service
-name: ResultSample
-# Version of the service
-version: 1
-# Description of the service
-description: >
-  ALv4 Result example service
-
-  This service provides examples of how to:
-     - define your service manifest
-     - use the different section types
-     - use tags
-     - use heuristics to score sections
-     - use the att&ck matrix
-     - use the updater framework
-     - define submission parameters
-     - define service configuration parameters
-
-# Regex defining the types of files the service accepts and rejects
-accepts: .*
-rejects: empty|metadata/.*
-
-# At which stage the service should run (one of: FILTER, EXTRACT, CORE, SECONDARY, POST)
-# NOTE: Stages are executed in the order defined in the list
-stage: CORE
-# Which category the service is part of (one of: Antivirus, Dynamic Analysis, External, Extraction, Filtering, Networking, Static Analysis)
-category: Static Analysis
-
-# Does the service require access to the file to perform its task
-# If set to false, the service will only have access to the file metadata (e.g. Hashes, size, type, ...)
-file_required: true
-# Maximum execution time the service has before it's considered to be timed out
-timeout: 60
-# Does the service force the caching of results to be disabled
-# (only use for service that will always provided different results each run)
-disable_cache: false
-
-# is the service enabled by default
-enabled: true
-# does the service make APIs call to other product not part of the assemblyline infrastructure (e.g. VirusTotal, ...)
-is_external: false
-# Number of concurrent services allowed to run at the same time
-licence_count: 0
-
-# service configuration block (dictionary of config variables)
-# NOTE: The key names can be anything and the value can be of any types
-config:
-  str_config: value1
-  int_config: 1
-  list_config: [1, 2, 3, 4]
-  bool_config: false
-
-# submission params block: a list of submission param object that define parameters
-#                          that the user can change about the service for each of its scans
-# supported types: bool, int, str, list
-submission_params:
-  - default: ""
-    name: password
-    type: str
-    value: ""
-  - default: false
-    name: extra_work
-    type: bool
-    value: false
-
-# Service heuristic blocks: List of heuristics object that define the different heuristics used in the service
-heuristics:
-  - description: This the first Heuristic for ResultSample service.
-    filetype: pdf
-    heur_id: AL_RESULTSAMPLE_1
-    name: Masks has PDF
-    score: 100
-    attack_id: T1001
-  - description: This is second Heuristic for ResultSample service.
-    filetype: exe
-    heur_id: AL_RESULTSAMPLE_2
-    name: Drops an exe
-    score: 1000
-  - description: This is third Heuristic for ResultSample service.
-    filetype: exe
-    heur_id: AL_RESULTSAMPLE_3
-    name: Extraction information
-    score: 0
-
-# Docker configuration block which defines:
-#  - the name of the docker container that will be created
-#  - cpu and ram allocation by the container
-docker_config:
-  image: cccs/assemblyline-service-resultsample:latest
-  cpu_cores: 1.0
-  ram_mb_min: 128
-  ram_mb: 256
-
-# Update configuration block
-update_config:
-  # list of source object from where to fetch files for update and what will be the name of those files on disk
-  sources:
-    - uri: https://file-examples.com/wp-content/uploads/2017/02/zip_2MB.zip
-      name: sample_2mb_file
-    - uri: https://file-examples.com/wp-content/uploads/2017/02/zip_5MB.zip
-      name: sample_5mb_file
-  # intervale in seconds at which the updater runs
-  update_interval_seconds: 300
-  # Should the downloaded files be used to create signatures in the system
-  generates_signatures: false
-```
-
-### Dockerfile
-
-A Dockerfile is required to build the service container that will be executed in the system.
-
-The following items must be set for all services:
-
-- All services must be based on the `cccs/assemblyline-v4-service-base:latest` image
-- An environment variable must be set for the service path
-- Install any service requirements
-- Copy the service code into `/opt/al/al_service/`
-
-```dockerfile
-FROM cccs/assemblyline-v4-service-base:latest
-
-# Set the service path
-ENV SERVICE_PATH result_sample.ResultSample
-
-# By default, the base service container as the assemblyline user as the running user
-#  switch to root to perform installation of dependancies
-USER root
-
-# See that we all these operations in one line to reduce
-#  the number of container layers and size of the container
-RUN apt-get update && apt-get install -y my_debian_apt_dependency_package && rm -rf /var/lib/apt/lists/*
-RUN pip install --no-cache-dir --user my_pip_dependency && rm -rf ~/.cache/pip
-
-# Change to the assemblyline user to make sure your service does not run as root
-USER assemblyline
-
-# Copy the service code in the service directory
-WORKDIR /opt/al_service
-COPY assemblyline_result_sample_service .
-```
-
-## Testing an Assemblyline service
-
-To test an Assemblyline service in standalone mode, the [run_service_once.py](https://github.com/CybercentreCanada/assemblyline-v4-service/src/master/dev/run_service_once.py) script can be used to run a single task through the service for testing. That script does not require that you have a working version of Assemblyline installed, all you need are the Assemblyline python libraries.
-
-### Setting up dev environment
-
-**NOTE:** The following environment setup has only been tested on Ubuntu 20.04.
-
-1. Install required packages
-
-    ```
-    sudo apt-get install build-essential libffi-dev python3.7 python3.7-dev python3-pip automake autoconf libtool
-    ```
-
-2. Install Assemblyline v4 service package
-
-    ```
-    pip install --no-cache-dir --user assemblyline-v4-service
-    ```
-
-3. Add your service development directory path (ie. `/home/ubuntu/assemblyline-v4-service`) to the PYTHONPATH environment variable
-
-### Using the `run_service_once.py` script
-
-#### Steps
-
-1. Ensure the current working directory is the root of the service directory of the service to be run
-
-   ```shell
-   cd assemblyline-service-<service name>
-   ```
-
-2. From a terminal, run the `run_service_once` script, where `<service path>` is the path to the service module and `<file path>` is the path of the file to be processed
-
-   ```shell
-   python3.11 -m assemblyline_v4_service.dev.run_service_once <service path> <file path>
-   ```
-
-
-3. The output of the service (`result.json` and extracted/supplementary files) will be located in a directory where the input file is located
-
-#### Example of running the ResultSample service
-
-1. Change working directory to root of the service:
-
-   ```shell
-   cd assemblyline_result_sample_service
-   ```
-
-2. From a terminal, run the `run_service_once` script
-
-   ```shell
-   python3.11 -m assemblyline_v4_service.dev.run_service_once assemblyline_result_sample_service.result_sample.ResultSample /home/ubuntu/testfile.doc
-   ```
-
-3. The `results.json` and any extracted/supplementary files will be outputted to `/home/ubuntu/testfile_resultsample`