{"id":1451,"date":"2020-05-11T11:36:27","date_gmt":"2020-05-10T23:36:27","guid":{"rendered":"http:\/\/p-s.co.nz\/wordpress\/?p=1451"},"modified":"2020-05-15T14:55:44","modified_gmt":"2020-05-15T02:55:44","slug":"an-easy-way-of-using-superhelp","status":"publish","type":"post","link":"https:\/\/p-s.co.nz\/wordpress\/an-easy-way-of-using-superhelp\/","title":{"rendered":"An easy way of using SuperHELP"},"content":{"rendered":"\n

Many people find using the command line a bit daunting and Jupyter notebooks unfamiliar so here is another way of using SuperHELP that may be much easier.<\/p>\n\n\n\n

  1. Put the following at the top of your script:

    import superhelp
    superhelp.this()<\/code>

    <\/li>
  2. Run the script<\/li>
  3. See the advice<\/li>
  4. Learn something; make changes \ud83d\ude42<\/li><\/ol>\n\n\n\n

    If you don’t want the default web output you can specify other output such as ‘cli’ (command line interface) or ‘md’ (markdown):<\/p>\n\n\n\n

    import superhelp\nsuperhelp.this(output='md')<\/code><\/pre>\n\n\n\n
    If you don’t want the default ‘Extra’ level of detail you can specify a different detail_level (‘Brief’ or ‘Main’) e.g.<\/p>\n\n\n\n
    import superhelp\nsuperhelp.this(output='md', detail_level='Brief')<\/code><\/pre>\n\n\n\n
    or:<\/p>\n\n\n\n
    import superhelp\nsuperhelp.this(detail_level='Main')<\/code><\/pre>\n\n\n\n
    \"\"<\/figure>\n\n\n\n
    Edited to remove reference to explicit file_path argument e.g. superhelp.this(__file__). It is not needed anymore thanks to the Python inspect library. Also displayer -> output and message_level -> detail_level.<\/p>\n","protected":false},"excerpt":{"rendered":"
    Many people find using the command line a bit daunting and Jupyter notebooks unfamiliar so here is another way of using SuperHELP that may be much easier. Put the following at the top of your script: import superhelpsuperhelp.this() Run the … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[11,3],"tags":[16,15,19],"class_list":["post-1451","post","type-post","status-publish","format-standard","hentry","category-programming","category-python","tag-help","tag-python","tag-tutorial"],"_links":{"self":[{"href":"https:\/\/p-s.co.nz\/wordpress\/wp-json\/wp\/v2\/posts\/1451"}],"collection":[{"href":"https:\/\/p-s.co.nz\/wordpress\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/p-s.co.nz\/wordpress\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/p-s.co.nz\/wordpress\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/p-s.co.nz\/wordpress\/wp-json\/wp\/v2\/comments?post=1451"}],"version-history":[{"count":8,"href":"https:\/\/p-s.co.nz\/wordpress\/wp-json\/wp\/v2\/posts\/1451\/revisions"}],"predecessor-version":[{"id":1459,"href":"https:\/\/p-s.co.nz\/wordpress\/wp-json\/wp\/v2\/posts\/1451\/revisions\/1459"}],"wp:attachment":[{"href":"https:\/\/p-s.co.nz\/wordpress\/wp-json\/wp\/v2\/media?parent=1451"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/p-s.co.nz\/wordpress\/wp-json\/wp\/v2\/categories?post=1451"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/p-s.co.nz\/wordpress\/wp-json\/wp\/v2\/tags?post=1451"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}