compox 2.0.0.dev1__tar.gz

compox-2.0.0.dev1/LICENSE

@@ -0,0 +1,218 @@
+Compox License
+Copyright 2025 TESCAN 3DIM, s.r.o.
+
+Licensed under the Apache License, Version 2.0 (the "License") modified 
+with Commons Clause Restriction; you may not use this file except in 
+compliance with the License. You may obtain a copy of the License at:
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, the software 
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 
+License for the specific language governing permissions and limitations 
+under the License.
+
+---- Commons Clause License Condition v1.0 ----
+
+The Software is provided to you by the Licensor under the License, as 
+defined below, subject to the following condition.
+
+Without limiting other conditions in the License, the grant of rights under 
+the License will not include, and the License does not grant to you, the 
+right to Sell the Software.
+
+For purposes of the foregoing, “Sell” means practicing any or all of the 
+rights granted to you under the License to provide to third parties, for a 
+fee or other consideration (including without limitation fees for hosting or 
+consulting/ support services related to the Software), a product or service 
+whose value derives, entirely or substantially, from the functionality of the 
+Software. Any license notice or attribution required by the License must also 
+include this Commons Clause License Condition notice.
+
+Software: Compox
+
+License: Apache 2.0
+
+Licensor: TESCAN 3DIM, s.r.o.
+
+---- End of Commons Clause ----
+
+---- Full Apache License, Version 2.0 Text ----
+
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

compox-2.0.0.dev1/NOTICE

@@ -0,0 +1,14 @@
+Compox
+Copyright 2025 TESCAN 3DIM, s.r.o.
+
+This project includes the following dependencies which carry NOTICE files:
+
+------------------------------------------------------------------------
+**requests** (licensed under Apache-2.0)
+NOTICE content included verbatim:
+“Copyright 2019 Kenneth Reitz”
+------------------------------------------------------------------------
+**boto3** (licensed under Apache-2.0)
+NOTICE content included verbatim:
+“Copyright 2013–2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.”
+------------------------------------------------------------------------

compox-2.0.0.dev1/PKG-INFO

@@ -0,0 +1,277 @@
+Metadata-Version: 2.4
+Name: compox
+Version: 2.0.0.dev1
+Author-Email: Jan Matula <jan.matula@tescan.com>, =?utf-8?q?Old=C5=99ich_Kodym?= <oldrich.kodym@tescan.com>
+License-Expression: Apache-2.0 AND LicenseRef-Commons-Clause-1.0
+License-File: LICENSE
+License-File: NOTICE
+License-File: THIRD_PARTY_LICENSES.txt
+Requires-Python: >=3.10.0
+Requires-Dist: fastapi>=0.100.1
+Requires-Dist: boto3>=1.36.0
+Requires-Dist: celery==5.3.1
+Requires-Dist: uvicorn>=0.25.0
+Requires-Dist: h5py>=3.9.0
+Requires-Dist: numpy<2.0.0
+Requires-Dist: natsort==8.4.0
+Requires-Dist: pytest>=7.4.2
+Requires-Dist: pydantic-settings>=2.0.3
+Requires-Dist: python-minifier>=2.9.0
+Requires-Dist: pystray>=0.19.5
+Requires-Dist: pywin32>=306; platform_system == "Windows"
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: toml>=0.10.2
+Requires-Dist: flower>=2.0.1
+Requires-Dist: python-multipart>=0.0.20
+Requires-Dist: mangum>=0.19.0
+Requires-Dist: requests==2.32.3
+Requires-Dist: pycurl>=7.45.4
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: typer>=0.16.0
+Requires-Dist: pip>=25.2
+Requires-Dist: build>=1.3.0
+Description-Content-Type: text/markdown
+
+# Compox
+Compox is a simple Python execution engine based on FastAPI with a MinIO object storage and Celery task queue. The app is designed to run algorithms written in Python on the server and report the results to the user.
+## Installation
+Compox can be installed through PyPI: 
+```bash
+pip install compox
+```
+
+You can also install the server by cloning this repository and installing it from source.
+
+Note that some additional dependencies, such as MinIO executable for your operating system, will be downloaded on the first run of the server.
+
+## Running the server
+Once installed into your Python environment, it's recommended to generate an initial configuration file with `compox generate-config`. 
+To see the available options for the `generate-config` command, you can run:
+
+```bash
+compox generate-config --help
+```
+
+The Compox can be run using the `compox` command. This command is available in the virtual environment created during the setup process. Run the following command to list the available commands:
+
+```bash
+compox --help
+```
+
+To run the Compox, use the following command:
+
+```bash
+compox run --config /path/to/config.yaml
+```
+
+### Deploying algorithms
+A future release of this package will include a detailed tutorial on how to prepare a data processing algorithm for T3D applications. 
+
+Once your algorithm is ready, you can use the `compox deploy-algorithms` command to deploy it to your server. This command will read the algorithm definitions from the specified configuration file and deploy them to the server. For example:
+
+```bash
+compox deploy-algorithms --config /path/to/config.yaml
+```
+
+To see the available options for the `deploy-algorithms` command, you can run:
+
+```bash
+compox deploy-algorithms --help
+```
+
+## Configuration
+The server uses pydantic settings for configuration. The configuration can be either set in a yaml file or as arguments when running the server.
+
+- Ensure all paths and URLs are correctly set before running the application.
+- Adjust CUDA settings based on hardware capabilities.
+- Logging paths should be accessible by the application to prevent errors.
+- MinIO settings must align with whether it is run locally or through an external S3 service.
+- See the [configuration reference](#configuration-reference) below for detailed configuration options.
+
+<details><summary>Configuration reference</summary>
+
+<br>
+
+### Compox Configuration Reference
+
+| Section                         | Field                      | Default                            | Description                                                                 |
+|----------------------------------|-----------------------------|------------------------------------|-----------------------------------------------------------------------------|
+|                                  | `port`                    | `5461`                             | The main server port used to make requests                                 |
+|                                  | `deploy_algorithms_from`  | `"./algorithms"`                   | Directory for algorithm deployment sources.                                |
+|                                  | `log_path`                | `"LOG_DEFAULT:compox.log"`     | Path to the main log file (supports dynamic prefixes).                     |
+|                                  | `config`                  | `None`                             | Optional config path override.                                             |
+| `info`                           | `product_name`              | `"TESCAN 3D Backend"`              | Product display name.                                                      |
+| `info`                           | `server_tags`               | `[]` → auto appends `"compox"` | Tags attached to the server. `"compox"` is added automatically.        |
+| `info`                           | `group_name`                | `"TESCAN GROUP, a.s."`             | Name of the corporate group.                                               |
+| `info`                           | `organization_name`         | `"TESCAN 3DIM, s.r.o."`            | Full name of the organization.                                             |
+| `info`                           | `organization_domain`       | `"tescan3dim.com"`                 | Domain used in server configuration.                                       |
+| `info`                           | `version`                   | `"0.1"`                            | Semantic version of the server release.                                   |
+| `gui`                            | `algorithm_add_remove_in_menus` | `False`                        | Enables/disables GUI menu for algorithm management.                        |
+| `gui`                            | `use_systray`               | `False`                            | Enables/disables systray GUI integration.                                  |
+| `gui`                            | `icon_path`                 | `"../compox/resources/compoxbackend.ico"` | Path to the systray icon (supports dynamic prefixes)               |
+| `storage`                        | `collection_prefix`         | `""`                               | Prefix applied to object store collections. (useful for AWS s3 store, where unique bucket names are needed)|
+| `storage`                        | `data_store_expire_days`    | `1`                                | Number of days until stored datasets expire.                               |
+| `storage`                        | `access_key_id`             | `UUIDv4`                           | Generated access key for storage backend. If `null` is provided, random UUIDv4 is generated. |
+| `storage`                        | `secret_access_key`         | `UUIDv4`                           | Generated secret key for storage backend. If `null` is provided, random UUIDv4 is generated. |S
+| `storage.backend_settings` (minio) | `provider`                | `"minio"`                          | Selected backend provider.                                                 |
+| `storage.backend_settings` (minio) | `start_instance`         | `True`                             | Whether to start a local MinIO server.                                     |
+| `storage.backend_settings` (minio) | `port`                   | `9091`                             | MinIO service port.                                                        |
+| `storage.backend_settings` (minio) | `console_port`           | `9090`                             | MinIO admin console port.                                                  |
+| `storage.backend_settings` (minio) | `executable_path`        | `"minio/minio_bin"`                | Path to the MinIO binary (accepts dynamic prefixes).                |
+| `storage.backend_settings` (minio) | `storage_path`           | `"minio/compox_store"`         | Storage directory used by MinIO (accepts dynamic prefixes).         |
+| `storage.backend_settings` (minio) | `aws_region`             | `None`                             | Optional AWS compatibility region.                                         |
+| `storage.backend_settings` (minio) | `s3_domain_name`         | `None`                             | Optional domain override for S3 compatibility.                             |
+| `storage.backend_settings` (minio) | `s3_endpoint_url`        | Derived from `port`                | Computed as `http://localhost:{port}`.                                     |
+| `storage.backend_settings` (aws)   | `provider`                | `"aws"`                            | AWS backend selection.                                                     |
+| `storage.backend_settings` (aws)   | `s3_endpoint_url`        | `None`                             | Optional override for S3 endpoint URL.                                     |
+| `storage.backend_settings` (aws)   | `aws_region`             | `None`                             | AWS region (e.g. `us-east-1`).                                             |
+| `storage.backend_settings` (aws)   | `s3_domain_name`         | `None`                             | Domain used for S3-style URLs.                                             |
+| `inference`                       | `device`                   | `"cuda"`                           | Device used for model inference (`"cpu"`, `"cuda"`, `"mps"`).              |
+| `inference`                       | `cuda_visible_devices`     | `"0"`                              | Comma-separated list of visible CUDA GPUs.                                 |
+| `inference.backend_settings` (fastapi) | `executor`           | `"fastapi_background_tasks"`       | Task executor type.                                                        |
+| `inference.backend_settings` (fastapi) | `worker_number`       | `1`                                | Number of worker threads for FastAPI tasks.                                |
+| `inference.backend_settings` (celery) | `executor`            | `"celery"`                         | Task executor type.                                                        |
+| `inference.backend_settings` (celery) | `worker_name`         | `"compox_worker"`                     | Name of the Celery worker.                                                 |
+| `inference.backend_settings` (celery) | `broker_url`          | **Required**                       | URL of the message broker (e.g. `amqp://`, `redis://`).                    |
+| `inference.backend_settings` (celery) | `result_backend`      | `"rpc://"`                         | Backend used to store task results.                                        |
+| `inference.backend_settings` (celery) | `run_flower`          | `False`                            | Whether to start a Flower dashboard.                                       |
+| `inference.backend_settings` (celery) | `flower_port`         | `None`                             | Port for Flower UI (if `run_flower` is True).                              |
+| `ssl`                              | `use_ssl`                 | `False`                            | Enables HTTPS if True.                                                     |
+| `ssl`                              | `ssl_keyfile`             | `None`                             | Optional path to the SSL key file (accepts dynamic prefixes).         |
+| `ssl`                              | `ssl_certfile`            | `None`                             | Optional path to the SSL certificate file (accepts dynamic prefixes). |
+| `middleware`                       | `allow_origins`           | `[]`                               | List of allowed CORS origins.                                              |
+| `middleware`                       | `allow_methods`           | `["GET"]`                          | HTTP methods permitted in CORS.                                            |
+| `middleware`                       | `allow_headers`           | `[]`                               | Custom headers permitted in CORS.                                          |
+| `middleware`                       | `allow_credentials`       | `False`                            | Whether to allow credentials in CORS.                                      |
+| `middleware`                       | `expose_headers`          | `[]`                               | Headers exposed to browsers.                                               |
+| `middleware`                       | `max_age`                 | `3600`                             | Cache time (in seconds) for CORS preflight.                                |
+
+
+Some fields in the Compox configuration (such as `log_path`, `icon_path`, `ssl_keyfile`, etc.) support **dynamic prefixes** that resolve to OS-specific or runtime-specific paths. This allows for portability across platforms (e.g., Windows, Linux) and between development and production environments.
+
+#### Supported Prefixes
+
+| Prefix                   | Meaning (Resolved To...)                                                                 |
+|--------------------------|------------------------------------------------------------------------------------------|
+| `LOG_DEFAULT:`           | A platform-dependent log directory:                                                     |
+|                          | - Windows: `%TEMP%/<organization>/<product>`                                            |
+|                          | - Linux/macOS: `/var/log/<organization>/<product>`                                      |
+| `PROGRAMDATA_DEFAULT:`   | A system-wide data directory (Windows only):                                            |
+|                          | - e.g., `%PROGRAMDATA%/<organization>/<product>`                                        |
+|                          | - On Linux/macOS, defaults to `"."` (current dir)                                       |
+| `RELATIVE_DEFAULT:`      | A relative path to the current executable (PyInstaller compatible):                     |
+|                          | - If bundled: `sys._MEIPASS/<path>`                                                     |
+|                          | - Otherwise: `"./<path>"`                                                               |
+
+> These are resolved **at runtime** in the `Settings.parse_paths()` validator method.
+
+#### Example
+
+```yaml
+log_path: "LOG_DEFAULT:compox.log"
+ssl:
+  use_ssl: true
+  ssl_keyfile: "PROGRAMDATA_DEFAULT:ssl/server.key"
+  ssl_certfile: "PROGRAMDATA_DEFAULT:ssl/server.crt"
+gui:
+  icon_path: "RELATIVE_DEFAULT:resources/icon.ico"
+```
+
+## Server Execution and Tooling
+
+Compox can be run using the `compox` command. This command is available in the virtual environment created during the setup process. Run the following command to list the available commands:
+
+```bash
+compox --help
+```
+
+### Running the Server
+To run the Compox, use the following command:
+
+```bash
+compox run --config config.yaml
+```
+
+Replace `config.yaml` with the path to your configuration file. The server will start and listen on the port specified in the configuration.
+You can also specify the configuration file directly in the command line, which will override the default configs and the configuarion field in the config file. Nested configuration fields can be specified using dot notation. For example, to set the executor to `celery` and the worker name to `my_worker`, you can run:
+
+```bash
+compox run --config config.yaml --inference.backend_settings.executor celery --inference.backend_settings.worker_name my_worker
+```
+
+To see the available options for the `run` command, you can run:
+
+```bash
+compox run --help
+```
+
+### Worker spawning (for Celery)
+To spawn a Celery worker, you can use the `compox spawn-worker` command. This command will start a Celery worker with the specified configuration. You can specify the worker name and other settings as needed. For example:
+
+```bash
+compox spawn-worker --config config.yaml --inference.backend_settings.worker_name my_worker
+```
+
+To see the available options for the `spawn-worker` command, you can run:
+
+```bash
+compox spawn-worker --help
+```
+
+### Running tests
+To run the tests, you can use the `compox test` command. This command will run the tests defined in the `tests` directory. You should provide the path to the folder containing the tests (`--test-path`), which is `tests` by default. You can either provide a path to a specific configuration file (`--config`), which will spawn a server instance and run the tests against it, or you can run the tests against a running server instance by providing the `--server-url` argument. For example:
+
+```bash
+compox test --test-path tests --config config.yaml
+```
+
+To see the available options for the `test` command, you can run:
+
+```bash
+compox test --help
+```
+
+### Deploy algorithms
+To deploy algorithms to the server, you can use the `compox deploy-algorithms` command. This command will read the algorithm definitions from the specified configuration file and deploy them to the server. For example:
+
+```bash
+compox deploy-algorithms --config app_server.yaml
+```
+
+To see the available options for the `deploy-algorithms` command, you can run:
+
+```bash
+compox deploy-algorithms --help
+```
+
+### Generate configuration
+If you don't have a configuration file, you can generate a default configuration file using the `compox generate-config` command. This command will create a default configuration file in the specified path. You can also override the default fields in the configuration file by providing them as command line arguments. You will be prompted if you try to generate a configuration file that already exists. For example:
+
+```bash
+compox generate-config --path app_server.yaml --port 8888 --gui.use_systray True
+```
+
+To see the available options for the `generate-config` command, you can run:
+
+```bash
+compox generate-config --help
+```
+
+### Serving documentation
+You can update documentation by navigating to the `python-computing-backend/compox/docs` directory and running the following command:
+
+```bash
+make.bat html
+```
+
+This will generate the documentation in the `_build/html` directory. After the documentation is built, you can serve it using the `compox serve-docs` command. This command will start a simple HTTP server to serve the documentation files. You can specify the directory where the documentation is located and the port on which to serve it. For example:
+
+```
+compox serve-docs --directory docs/_build/html --port 8000
+```
+
+To see the available options for the `serve-docs` command, you can run:
+
+```bash
+compox serve-docs --help
+```