python naming conventions files

Author: Sagar Chalise

docs/python/classes.md

@@ -0,0 +1,13 @@
+---
+id: classes
+title: Classes
+sidebar_label: Classes
+---
+
+
+#### Contents...
+
+* Classes names should always be `PascalCase`. i.e. `MyClass` 
+* Avoid inbuilt names for class.
+* Even if you are building datatypes based on inbuilt class use PascalCase. i.e. `MyDict(dict):`
+* Describe the class resposibility in name.

docs/python/files.md

@@ -0,0 +1,20 @@
+---
+id: files
+title: Files & Folders
+sidebar_label: Files & Folders
+---
+
+## Contents...
+
+
+####Naming Conventions
+
+* Name in `snake_case` or descriptive single words all in **lowercase**. E.g. `helper.py` or `sftp_fetcher.py` or `tools`
+* Be explicit and descriptive of their functionality. Donot have short and ambigous file and folder names.
+    - E.g. `utils.py` or `utils` will describe of utility.
+    - E.g. `aws_helper.py` will describe helper related to AWS.
+* Donot Clash names with inbuilt and famous modules.
+    - E.g. donot use `requests.py` or `list.py`
+* Be consistent when you are naming. Go with one form when choosing singular or plural names. i.e. 
+    - :ballot_box_with_check: `tools`, `utils` or `tool`, `util` :x: `tools`, `util`  
+* When designing OOP styled files, go for `abstract.py`, `base.py` or `parent.py` like files/folders for abstract classes.

docs/python/functions.md

@@ -0,0 +1,13 @@
+---
+id: functions
+title: Function
+sidebar_label: Functions
+---
+
+#### 1. Contents...
+
+* `snake_case` or descriptive single word in **lowercase** should be used.
+*  function names should explain the functionality.
+* for bound methods `self` should be used for first argument.
+* for class methos `cls` should be used for first argument.
+* `decorators` should be named in function convention.

docs/python/variables.md

@@ -0,0 +1,16 @@
+---
+id: variables
+title: Variables
+sidebar_label: Variables
+---
+
+#### 1. Contents...
+
+* `snake_case` or descriptive word all in **lowercase** for any type of variables except `CONSTANTS`.
+* `ALL_CAPS` for constants. `python` doesnot have the concept of constants so this is just a convention.
+* Variable Privacy
+    - `__{variable_name}` if you want something to be private. 
+    - `_{variable_name}` if you want something to be not publicly used or something that may change later. 
+    - `__{variable_name}` are not directly accesible while `_{variable_name}` are. They are just for convention.
+* Avoid builtin variable clash. Especially in globals. You can attach `_` as suffix to builtin names if you deem the name necessary for your variable.
+    - `all` or `id` is very tempting variable names but they are builtin methods in python. Go with `all_` or `id_` for these or better yet choose something else as a name.