shubhamgupta-dat / datasciencestyleguide Goto Github PK

View Code? Open in Web Editor NEW

1.0 2.0 0.0 97 KB

Style Guide for Data Science Developers

License: MIT License

datasciencestyleguide's Introduction

Data Science Style Guide

With great power there must also come great responsibility!

Anatomy of a Code

1. Background

Python is the primary language being used, by Data Science Teams, to develop and deploy solutions. It is important for various developers to remain on the same page. This style guide is a list of DOs and DON'Ts for the team's developer. This can be referred by internal and other teams and suggestions are welcome. This style guide is inspired by the Google's style guide for python. Author(s) have added more information and modified few important points to accommodate specific use-cases for development in all kinds of environment.

These best practices can be used while working on interactive python notebooks or while writing production level code on any IDE.

Preferred IDEs:

PyCharm Community Edition
pyzo
Vim

We have tried to cover important topics such as:

5. Jupyter Notebook Best Practices

6. Library Development Best Practices

🚧 Men at Work! 🚧

Coming Soon, Near You!

Jupyter Notebook Best Practices
Library Development Best Practices

datasciencestyleguide's People

Contributors

Stargazers

Watchers

datasciencestyleguide's Issues

(Zeke) Change this to use relations.

DataScienceStyleGuide/content/python_style_rules/README.md

Lines 663 to 668 in bd4ce8d

    
           # TODO(Zeke) Change this to use relations. 
        
           ``` 
        
           <a id="s3.12-imports-formatting"></a> 
        
           <a id="312-imports-formatting"></a>

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

Comments

DataScienceStyleGuide/content/python_style_rules/README.md

Lines 650 to 655 in bd4ce8d

    
           ### 3.12 TODO Comments  
        
           - Use `TODO` comments for code that is temporary, a short-term solution, or 
        
           good-enough but not perfect. 
        
           - A `TODO` comment begins with the string `TODO` in all caps and a parenthesized name, e-mail address, or other identifier of the person or issue with the best context about the problem. This is followed by an explanation of what there is to do.

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

`, it is almost always your name that is given.

DataScienceStyleGuide/content/python_style_rules/README.md

Lines 659 to 664 in bd4ce8d

	- A `TODO` is not a commitment that the person referenced will fix the problem. Thus when you create a `TODO`, it is almost always your name that is given.

	```python
	# TODO([email protected]): Use a "*" here for string repetition.
	# TODO(Zeke) Change this to use relations.
	```

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

` in all caps and a parenthesized name, e-mail address, or other identifier of t...

DataScienceStyleGuide/content/python_style_rules/README.md

Lines 655 to 660 in bd4ce8d

    
           - A `TODO` comment begins with the string `TODO` in all caps and a parenthesized name, e-mail address, or other identifier of the person or issue with the best context about the problem. This is followed by an explanation of what there is to do. 
        
           - The purpose is to have a consistent `TODO` format that can be searched to find out how to get more details.  
        
           - A `TODO` is not a commitment that the person referenced will fix the problem. Thus when you create a `TODO`, it is almost always your name that is given.

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

` comments for code that is temporary, a short-term solution, or

DataScienceStyleGuide/content/python_style_rules/README.md

Lines 652 to 657 in bd4ce8d

    
           - Use `TODO` comments for code that is temporary, a short-term solution, or 
        
           good-enough but not perfect. 
        
           - A `TODO` comment begins with the string `TODO` in all caps and a parenthesized name, e-mail address, or other identifier of the person or issue with the best context about the problem. This is followed by an explanation of what there is to do. 
        
           - The purpose is to have a consistent `TODO` format that can be searched to find out how to get more details.

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

` format that can be searched to find out how to get more details.

DataScienceStyleGuide/content/python_style_rules/README.md

Lines 657 to 662 in bd4ce8d

	- The purpose is to have a consistent `TODO` format that can be searched to find out how to get more details.

	- A `TODO` is not a commitment that the person referenced will fix the problem. Thus when you create a `TODO`, it is almost always your name that is given.

	```python
	# TODO([email protected]): Use a "*" here for string repetition.

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

-comments"></a>

DataScienceStyleGuide/content/python_style_rules/README.md

Lines 646 to 651 in bd4ce8d

    
           <a id="s3.12-todo-comments"></a> 
        
           <a id="312-todo-comments"></a> 
        
           <a id="todo"></a> 
        
           ### 3.12 TODO Comments

This issue was generated by todo based on a `todo` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

Add Description

DataScienceStyleGuide/content/python_style_rules/README.md

Lines 3 to 8 in bd4ce8d

    
           #TODO: Add Description 
        
           ### 3.1 Semicolons  
        
           Do not terminate your lines with semicolons, and do not use semicolons to put 
        
           two statements on the same line.

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

([email protected]): Use a "*" here for string repetition.

DataScienceStyleGuide/content/python_style_rules/README.md

Lines 662 to 667 in bd4ce8d

	# TODO([email protected]): Use a "*" here for string repetition.
	# TODO(Zeke) Change this to use relations.
	```

	<a id="s3.12-imports-formatting"></a>
	<a id="312-imports-formatting"></a>

	### 3.12 TODO Comments

	- Use `TODO` comments for code that is temporary, a short-term solution, or
	good-enough but not perfect.

	- A `TODO` comment begins with the string `TODO` in all caps and a parenthesized name, e-mail address, or other identifier of the person or issue with the best context about the problem. This is followed by an explanation of what there is to do.

	<a id="s3.12-todo-comments"></a>
	<a id="312-todo-comments"></a>

	<a id="todo"></a>
	### 3.12 TODO Comments

	#TODO: Add Description

	### 3.1 Semicolons

	Do not terminate your lines with semicolons, and do not use semicolons to put
	two statements on the same line.

shubhamgupta-dat / datasciencestyleguide Goto Github PK

datasciencestyleguide's Introduction

Data Science Style Guide

1. Background

Preferred IDEs:

2. Python Language Rule

3. Python Style Rules

4. Python Usability Best Practices

5. Jupyter Notebook Best Practices

6. Library Development Best Practices

🚧 Men at Work! 🚧

Coming Soon, Near You!

datasciencestyleguide's People

Contributors

Stargazers

Watchers

datasciencestyleguide's Issues

This issue was generated by todo based on a TODO comment in bd4ce8d. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a TODO comment in bd4ce8d. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a TODO comment in bd4ce8d. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a TODO comment in bd4ce8d. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a TODO comment in bd4ce8d. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a TODO comment in bd4ce8d. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a todo comment in bd4ce8d. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a TODO comment in bd4ce8d. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a TODO comment in bd4ce8d. It's been assigned to @shubhamgupta-dat because they committed the code.

Recommend Projects

Recommend Topics

Recommend Org

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a `todo` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.

This issue was generated by todo based on a `TODO` comment in `bd4ce8d`. It's been assigned to @shubhamgupta-dat because they committed the code.