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):

python ./src/cli/main.py <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:

python ./src/cli/main.py <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.11.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.11-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: productmap_cli-0.1.11.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.11.tar.gz
Algorithm Hash digest
SHA256 724d7e7f81a52f361f25360bbc8030c0421214b4be80334a18fec265c6b3a5e9
MD5 fec4f9bacbf7397c18fcc2c318b9d84a
BLAKE2b-256 68b1f05bac5017c49c5561e386ac56ae3cc11f7416e7a8fc769442801d403cb1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for productmap_cli-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 47989bf1273f55341bdf3b26357ce80098bd9d4803cda67dece2ece2a546ee89
MD5 26c52df4784acf064583678e14b6be78
BLAKE2b-256 9c551fd662c724857fbffaae7c524a12647f90eb930e9f40a52f69282f38948a

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