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.14.tar.gz (5.1 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.14-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: productmap_cli-0.1.14.tar.gz
  • Upload date:
  • Size: 5.1 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.14.tar.gz
Algorithm Hash digest
SHA256 6872f3cf2705e56683e3949ccabd052e902a44639c0b73d6f25e3da15eab5ed4
MD5 d437301d89d5ff8d2c552efe970c242e
BLAKE2b-256 e2f68a92539febb64cf0b7cc1ad17e1232b66d651de6bf7860c2142c462a0e41

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for productmap_cli-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 a45e4fae8e2147e7752c1e3f43a11234267474d58c4df72b3b6f5238e09040d0
MD5 2c27c8d1a193213d50b28bb1bb8e7974
BLAKE2b-256 0c30e9a4aa17fbfec93e7f998bb9f83efa47f5a7c40119ff4fa5aa21f668ae0d

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