pennsignals / aptos

:sunny: A tool for validating data using JSON Schema and converting JSON Schema documents into different data-interchange formats
Apache License 2.0
150 stars 22 forks source link

Add instruction on using CLI in windows prompt #11

Closed TheWindRider closed 6 years ago

TheWindRider commented 6 years ago

The example script in the Data Validation CLI section needs a little adaptation to work in windows prompt, otherwise double quotes won't be recognized and error will be reported as screenshot at bottom.

I may contribute an easy solution for windows to the README, but I don't know how to apply font color to output message in windows prompt.

validate_cli

ghost commented 6 years ago

Your issue doesn't follow our guidelines. Please fix the following:

Click here for details.

Thank you! :pray: This comment was made by GitMagic – Magically enforcing your contribution guidelines.

TheWindRider commented 6 years ago

@gitmagic-bot Looks like I don't have permission to add labels?

jasonwalsh commented 6 years ago

Hi @TheWindRider, thanks for reporting this. I think updating the README is a good idea.

As for coloring terminal output, I'm currently using the TermColors class. However, I think the __main__ module could be cleaned up a bit. I also found the termcolor module on PyPI and think it might be a better solution than using the TermColors class.

Any thoughts?

TheWindRider commented 6 years ago

Ok I will work on the README. @rightlag Would you prefer a new pair of screenshots, or more low-key modification like one line of example code that works in windows terminal?

I don't have good knowledge about the PyPI unfortunately.

jasonwalsh commented 6 years ago

Just adding the Windows command should be fine. Could you also add headers above the commands (e.g.):

macOS

$ command

Windows

> command