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.12.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.12-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: productmap_cli-0.1.12.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.12.tar.gz
Algorithm Hash digest
SHA256 b3c8a56f1a4356654f33c73e22502f5d7c678c35b15ee33900a9fbe2201d8d85
MD5 6fd81ed47cddcb089ce1735044388666
BLAKE2b-256 891f048fd36c571506672fc670148222333ac08ee379e8045059390ac835d1a0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for productmap_cli-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 5981ca45da38c6356676673fdec2d0977c946f7da07282b0685fe9d4fa1e9b96
MD5 c26378bad1f857eac1353bc9e1000c33
BLAKE2b-256 d81e4e6df3d2b33cec72ad71f6ae819a8b4dcd115233e206601e11e6b9a146b3

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