Package: nc-console
nc-consoleThe programmatic consoler.Checkout the official documentation atnc-console.netlify.appOfficial PYPI link :pypiNow it's quite easy to log the status and take inputs from the terminal using nc-colsole.Introductionnc-console provides you a clean, understandable and programmatic overview to log your data on the terminal or take inputs from the terminal.It's internally using theclickmodule frompalletsprojectsto deliver such services.RequirementsTo use this module you must need to use Python version 3.6 or grater than it.This module requires the following modules:click==8.0.1InstallationYou can install the package from the official PYPI:pipinstallnc-consoleYou can install it directly from the source code:gitclonehttps://github.com/marktennyson/nc-console.git&&cdnc-colsole
pythonsetup.pyinstallUsageImplementation of logging system.It gives you a very logical way to print your logging output.For a basic example:fromnc_consoleimportConsoleConsole.log.Info("This is the first info message.")And the output will be:[INFO]Thisisthefirstinfomessage.Available options/methods to print the different log:Console.log.Info()# to log a info type message.Console.log.Warning()# to log a warning type message.Console.log.Success()# to log a success type message.Console.log.Error()# to log a error type message.The default colour for typeinfoisbright_blue.The default colour for typesuccessisbright_green.The default colour for typewarningisbright_magenta.The default colour for typeErrorisbright_red.The default colour formessageisyellow.It's very easy to change the default colours. To do this please go with the below mentioned steps:fromnc_consoleimportConsoleConsole.setLogConfig(box_colour="cyan"type_info_colour="red"...)So using thesetLogConfigmethod you can adjust the default colours.
Available parameters for thesetLogConfigmethod are:box_colour : to change the box([]) colour.msg_colour : to change the colour of message.type_info_colour : to change the base colour for the type info.type_success_colour : to change the base colour for the type success.type_warning_colour : to change the base colour for the type warning.type_error_colour : to change the base colour for the type error.All of the colours accept the default available colour forclick.style.Implementation of input system.Beside the logging system this module is able to take inputs from the terminal too. This system will give you the feel like Java.For a basic example:fromnc_consoleimportConsole#To take a string based input from the terminalname=Console.input.String("Enter your name: ")#To take a Integer based input from the terminalage=Console.input.Integer("Enter your age: ")The output will be:[INPUTSTRING]Enteryourname:[INPUTINTEGER]Enteryourage:Available options/methods to take different types of input from the terminal:Console.input.String()# to take a string type input.Console.input.Password()# to take a password type input.Console.input.Integer()# to take a integer type input.Console.input.Float()# to take a float type input.Console.input.Boolean()# to take a blooean type input(Y/n).The default colour fortypeisbright_blue.The default colour formessageisyellow.It's very easy to change the default colours for the input system too. To do this please go with the below mentioned steps:fromnc_consoleimportConsoleConsole.setInputConfig(box_colour="cyan"msg_colour="red"...)So using thesetInputConfigmethod you can adjust the default colours.
Available parameters for thesetLogConfigmethod are:box_colour : to change the box([]) colour.msg_colour : to change the colour of message.base_colour : to change the base colour for the input text.type_colour : to change the input type colour.All of the colours accept the default available colour forclick.style.MaintainersCurrent Maintainers:Aniket sarkar akamarktennysonContributorsCurrent Contributors:ContributionIf you want to become a contributor of this project then please contact me at =>aniketsarkar@yahoo.comor follow the below mentioned steps.Fork and clone this repository.Make some changes as required.Write unit test to showcase its functionality.Submit a pull request underdevelopmentbranch.