Python code clean-up for beginners: 7 steps to readable and maintainable code

If you apply for a job, your take-home test task should be your best shot.

Usually, it’s easy to see when it’s a beginner’s code. Recruiters look at the project, and something immediately catches their eyes and bias their judgment: inconsistent formatting, clutter in the repository, leftovers of debugging prints, etc. In his talk, Roman outlines common red flags that he saw reviewing test tasks and exploring public code on GitHub. Along with them, he provides some methods to make a good impression with your code, increase the chances to win that job offer, and become a better developer.

Transcript

1. roman.pt rdotpy Python code cleanup for beginners Seven steps to readable and maintainable code
2. roman.pt rdotpy When in doubt, dress up a little
3. roman.pt rdotpy What can I easily improve?
4. roman.pt rdotpy Declutter 1
5. roman.pt rdotpy
6. roman.pt rdotpy PyCharm configuration
7. roman.pt rdotpy PyCharm configuration VSCode configuration
8. roman.pt rdotpy PyCharm configuration VSCode configuration Python bytecode
9. roman.pt rdotpy PyCharm configuration VSCode configuration Python bytecode Virtual environment
10. roman.pt rdotpy PyCharm configuration VSCode configuration Python bytecode Virtual environment mac-specific folder metadata
11. roman.pt rdotpy Problems with cluttered code • It drastically increases the size of your repository • It pollutes your commits with irrelevant content • It can ruin team work with fi le con fl icts • You can accidentally expose your private info
12. roman.pt rdotpy .gitignore github.com/github/gitignore
13. roman.pt rdotpy
14. roman.pt rdotpy 4 things to remove from code help developers focus
15. roman.pt rdotpy 1. Unused imports 1.1
16. roman.pt rdotpy
17. roman.pt rdotpy
18. roman.pt rdotpy
19. roman.pt rdotpy 2. Unused variables 1.2
20. roman.pt rdotpy
21. roman.pt rdotpy
22. roman.pt rdotpy
23. roman.pt rdotpy 3. Commented out code 1.3
24. roman.pt rdotpy
25. roman.pt rdotpy
26. roman.pt rdotpy 4. Debugging prints 1.4
27. roman.pt rdotpy
28. roman.pt rdotpy
29. roman.pt rdotpy
30. roman.pt rdotpy Better than prints
31. roman.pt rdotpy No passwords in the code! 2
32. roman.pt rdotpy
33. roman.pt rdotpy
34. roman.pt rdotpy
35. roman.pt rdotpy
36. roman.pt rdotpy saurabh-kumar.com/python-dotenv
37. roman.pt rdotpy django-environ.readthedocs.io
38. roman.pt rdotpy dynaconf.com
39. roman.pt rdotpy Make a README makeareadme.com 3
40. roman.pt rdotpy Suggestions for a good README • Name • Description • Badges • Visuals • Installation • Usage • Support • Roadmap • Contributing • Authors and acknowledgements • License • Project status
41. roman.pt rdotpy Add requirements.txt 4
42. roman.pt rdotpy
43. roman.pt rdotpy
44. roman.pt rdotpy Paint it black 5
45. roman.pt rdotpy
46. roman.pt rdotpy
47. roman.pt rdotpy
48. roman.pt rdotpy
49. roman.pt rdotpy Follow PEP-8 conventions 6
50. roman.pt rdotpy
51. roman.pt rdotpy UPPERCASE_UNDERSCORE CamelCase lowercase_underscore lowercase_underscore
52. roman.pt rdotpy
53. roman.pt rdotpy Use a linter 7
54. roman.pt rdotpy
55. roman.pt rdotpy
56. roman.pt rdotpy
57. roman.pt rdotpy Challenge apply all the improvements to your code and shout to the world