Skip to main content

The ProductMap CLI tool for validation and execution of map generation process in the ProductMap tool

Project description

ProductMap CLI

This is a command line interface (CLI) for the ProductMap library. The CLI provides a way to interact with the library from the command line.

Install it

Use the following command to install the library:

pip install .

Usage

To use the library, you can create a script or run it directly from the command line (for local purposes):

pm-cli <your-product-map-token> --file=<file-path> --action=["generate", "validate"]

This setup provides a basic structure for validating and generating a product map. The logic for generating and validating the product map content will be added in the validate_file and generate_map functions.

Example

Here is an example of how to use the CLI to generate a product map:

pm-cli <your-product-map-token> --file="tests/sample_file/main.cpp" --action="validate"

This command will validate the content of the main.cpp file and should provide an output like this:

Validating file tests/sample_file/main.cpp
File 'tests/sample_file/main.cpp' successfully read! Size: 233 bytes.
File 'tests/sample_file/main.cpp' validated successfully!
{"valid":true,"lines_of_code":6,"consumed_lines_of_code":139437,"remaining_lines_of_code":10563}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

productmap_cli-0.1.15.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

productmap_cli-0.1.15-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file productmap_cli-0.1.15.tar.gz.

File metadata

  • Download URL: productmap_cli-0.1.15.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for productmap_cli-0.1.15.tar.gz
Algorithm Hash digest
SHA256 c672e33429cc3d6066945cb79971b178938398e9ee3b59ba99af957e0a741b19
MD5 879764faae902b85e6aa3465f6c03216
BLAKE2b-256 e4b11de6c0895cabf12034cab1d5b29c8235af546f0fa4176435db31abcb5055

See more details on using hashes here.

File details

Details for the file productmap_cli-0.1.15-py3-none-any.whl.

File metadata

File hashes

Hashes for productmap_cli-0.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 fb105978d4683115f51efa8ae54b25a20fdfc7643c73a6adbe0bd901ed9255f3
MD5 98c8a534bcb9975a72169dd004532b8e
BLAKE2b-256 ca23117cdc1e2723a99335a5ef88e9c3d897612410a78aecad1131b04aded8f4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page