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

Uploaded Python 3

File details

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

File metadata

  • Download URL: productmap_cli-0.1.16.tar.gz
  • Upload date:
  • Size: 6.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.16.tar.gz
Algorithm Hash digest
SHA256 6571a7eb090eaee737a70756c4850eae94e0a8cd61d686e43db562e14a4337cc
MD5 01f7868b924a0c6c12e860b87da8d702
BLAKE2b-256 5f2144351d272c93100f2c2806281a38776b4ec95a7972b556d950dad9dd29fc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for productmap_cli-0.1.16-py3-none-any.whl
Algorithm Hash digest
SHA256 a06e8b0c6328a03699ff688ea790bac9ae1f4e6e24ceea38b89c2a01360856f0
MD5 d8eb79aee681532509b3a0dd4e943834
BLAKE2b-256 1329a0156d5c91fe149a05348ae7d96eb6ddd0b94e5fc055eb49ef3d3985a856

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