LuminosoInsight / sales-engineering-code

Code for sales engineering, particularly for code that will be given to customers
MIT License
0 stars 0 forks source link

Adding a new help command #148

Closed wharter closed 2 years ago

wharter commented 2 years ago

Added a new helper command for customers using the wheel file. lumi-wheel will be the final command after the wheel file packaging is fix.

To test. python lumi-wheel.py Output looks like this.

lyra:se_code wharter$ python wheel_info.py
Luminoso Wheel File Information

The wheel file from Luminoso comes with the following commands

lumi-add-concept-relations-to-project
    Use shared concepts to tag documents and create a new project.
lumi-bi-tool-export
    Business Intelligence Export. Creates CSV files for use with business
    intelligence tools like Tableau, Microstrategy and PowerBI to name a few.
lumi-capitalize-saved-concepts
    Capitalize all the concepts in all the shared concept lists.
lumi-copy-project-with-filter
    Copy a project to a new project using a filter to exclude
    specific documents based on metadata fields.
lumi-copy-shared-concepts
    Copy shared concepts from one project to another.
lumi-create-train-test-split
    Will split a Compass voting classifier file into a training and test set.
lumi-doc-downloader
    Download documents from a project. This script can also tag each document
    with the shared concept lists with which it is associated.
lumi-format-multiple-text-fields
    This will take a CSV file with multiple text fields and combine them into
    a single text field with a new metadata column
lumi-ignore-terms
    Uses the /terms/manage endpoint which requires a project rebuild after
    setting the ignore terms.
lumi-notice-terms
    Notice concepts in a project. "Noticing" a concept means taking a text
    that the project ignored as unimportant, such as a number or a
    preposition, and telling the project not to ignore it.
lumi-list-metadata
    This simply lists all the metadata fields and how many unique values
    there are in each field.
lumi-load-shared-concepts
    This will upload a file of shared concepts to a daylight project.
lumi-project-migration
    Will copy all projects under a specific workspace to a separate
    server/workspace
lumi-score-drivers
    This can download score drivers for a project as well as generate
    output for score drivers over time.

More details on each command can be found by using a --help alone on
the command line.  ie.
    lumi-bi-tool-export --help

All Commands
lumi-add-concept-relations-to-project
lumi-bi-tool-export
lumi-capitalize-saved-concepts
lumi-copy-project-with-filter
lumi-copy-shared-concepts
lumi-create-train-test-split
lumi-doc-downloader
lumi-format-multiple-text-fields
lumi-ignore-terms
lumi-notice-terms
lumi-list-metadata
lumi-load-shared-concepts
lumi-project-migration
lumi-score-drivers
wharter commented 2 years ago

@Tahnan Let me know if this passes and I'm ready to do release. I have all the minor changes for the release staged in another local branch. I guess I can move that over here if that makes things clearer.