Easiest Way To Read Python Documentation

hi everyone in this video i'm going to be showing you how to check your python documentation and there may be instances in which you may be stuck and you may be wanting to refer to something in the docs so the beauty with python is that frame through the interactive shell you can be able to view whatever documentation you may want so what i'll do is to open up my terminal so i'm using batch because i'm on ubuntu but the same thing will apply if you're using something like let's say cmd or partial so i'll do is to come and open the terminal so i'm going to open my batch terminal and what i'll do is to call my python interpreter so this is going to open up an interactive python share now i have to enlarge it so that you guys can see so i need to enlarge this now what i'm going to do is to call the help function and once i call that whole function then it says welcome to python so this is python 3.8 and this is python 3.8 is help utility so you understand like if this is our first time using python you should definitely check out the tutorial and enter the name of any module keyword or tropic writing python programs and using python modules to quit just type quit so basically what you can do is to type in a module for example let's say i'm on i'm coding flask and let's say i have this kind of confusion about a certain a certain class in flask or a certain module within the flat within flask i can be able to just type a flask and within this help console i can be able to get the documentation of flask so for example you can see the package.com components such as the app module the blueprints module cli config context debug global's helper json and so on so you can even be able to see the different uh documentation of whatever you want so for example let's say we wanted to access a particular module class for example let's say flask dot blueprint so this is basically going to return uh documentation for flash catcher this is flashlight blueprints so you can be able to see the documentation about flask blueprints for example the class blueprint and whatever attributes that class has and that different documentation that you may have for that particular class so let's say i wanted to search for the jungler's framework so i quit that by pressing q so let's say i wanted to read about the jungler's framework and let's say i wanted to say jungle rest framework so if i open this uh we can be able to see the banner you can't see it well so let me kind of reduce so right now you can see the banner of january's framework as well as a different package components the different modules found within the genres framework so you can see things like apps authentication of token checks compact decorators documentation and so on so you can go ahead and read the various documentation now let's say i wanted to read about authentication so i'll quit this and then what i'll have to do is to say rest framework so this is going to be rest framework and dot authentication so right in here we can be able to access the different classes that are talking about uh the authentication in jungle rest framework so this is kind of helpful as you do not require to have a packet to go to the internet or download documentation while you can just go ahead and read it from your terminal or your command prompt in this video i've shown you how to basically go ahead and read the documentation using your python interactive shell thank you for watching guys and see you in the next video bye

Channel: Ssali Jonathan

Views: 1,304

Keywords: python, python3, python3-tutorial, python3 help, python help

Id: Rs4M-En1b1c

Length: 4min 10sec (250 seconds)

Published: Mon Oct 04 2021