You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: short_courses/data_science_best_practices.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,6 @@ While it is not essential to follow every recommendation to the letter, thoughtf
11
11
Most of the instructions in this guide require use of the commandline interface in a Unix based system (Mac and Linux). For use with Windows first install Gitbash via [Git for Windows](https://gitforwindows.org).
12
12
Where `{project-name}` is referenced, replace this with the name of your project _without_ the curly braces.
13
13
14
-
To get started you will need to make sure [Python](#language-python), [Git](#version-control-git) and [Poetry](#packaging-and-dependency-management-poetry) are installed.
15
14
Python and Git come pre-installed on both Mac and Linux systems, and Git is installed as part of Git for Windows, but Windows users will need to [download](https://www.python.org/downloads/) and install Python.
16
15
You will need to additionally install Poetry, which can be done from the [website](https://python-poetry.org/) or by running:
17
16
@@ -77,7 +76,7 @@ poetry add {package-name}
77
76
78
77
### Writing Code:
79
78
80
-
We recommend writing the majority of code using [VSCode](#ide-vscode) which will need [installing](https://code.visualstudio.com/Download) on all systems
79
+
We recommend writing the majority of code using VSCode which will need [installing](https://code.visualstudio.com/Download) on all systems
81
80
Core project code can be added to a new `module_name.py` file in `src/{project-name}/` and then functions, classes and variables from that module can be imported into other files using:
82
81
83
82
```python
@@ -167,7 +166,7 @@ A well-organized project structure is key to keeping code manageable, especially
167
166
-**.gitignore**: Defines what is and is not to be included in the git repository fot the project.
168
167
-**README.md**: Provides an overview of the project, setup instructions, and usage examples.
169
168
170
-
There will be some additional files created through use of [git](#version-control-git) and [VSCode](#ide-vscode).
169
+
There will be some additional files created through use of git and VSCode.
171
170
172
171
NOTE: files beginning `.` are hidden files and will not appear unless showing hidden files is specified, i.e. using:
0 commit comments