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.13.tar.gz (4.8 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.13-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: productmap_cli-0.1.13.tar.gz
  • Upload date:
  • Size: 4.8 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.13.tar.gz
Algorithm Hash digest
SHA256 742f908ff9c00e4090ac6804dc8c72f74347fa7c9915f2bb1c633d5a94bfdaf7
MD5 58c064f975ea2617ad7e38d0edf201c5
BLAKE2b-256 e4989a345ad35ceb79a378c508c35f20c485c0a25dd9701b27472be4b6592a70

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for productmap_cli-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 3431d3549a41585435bd98fa68c60e620140a1ce3d7f29d27e946f4e04f1bfc6
MD5 dd400ab2eeb44e2b4770dedc1b2a1972
BLAKE2b-256 ab169526d7974fb6041e3970481ac937b901c49ce90f0c40b0a7c53b74d0e87d

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