search

jerry-git / learn-python3

Jupyter notebooks for teaching/learning Python 3
MIT License
6.43k stars 1.77k forks source link

Add the logical ordering of Python Notesbooks #9

Closed atingupta2005 closed 1 year ago

atingupta2005 commented 6 years ago

When I cloned the repository on my local system, I am not able to follow the logical order of the notebooks. In other words on the Github Repository a logical order is specified against each topic as below:

  1. Strings [notebook] [exercise]
  2. Numbers [notebook] [exercise]
  3. Conditionals [notebook] [exercise]
  4. Lists [notebook] [exercise]
  5. Dictionaries [notebook] [exercise]
  6. For loops [notebook] [exercise]
  7. Functions [notebook] [exercise]
  8. Testing with pytest - part 1 [notebook] [exercise]
  9. Recap exercise 1 [exercise]
  10. File I\O [notebook] [exercise]
  11. Classes [notebook] [exercise]
  12. Exceptions [notebook] [exercise]
  13. Modules and packages [notebook]
  14. Debugging [notebook] [exercise]
  15. Goodies of the Standard Library - part 1 [notebook] [exercise]
  16. Testing with pytest - part 2 [notebook] [exercise]
  17. Virtual environment [notebook]
  18. Project structure [notebook]
  19. Recap exercise 2 [exercise]

But in the Cloned repository the files are in the albhatic order of the file name. There is no way to know in which order one should study. I think it will be better that we should put some index for these notebooks for easy navigation.

Also the same situation for HTML pages. There should be some logical order for those.

Thanks

jerry-git commented 5 years ago

Thanks for the feedback!

The recommended order is defined in the README which is also part of a clone. However, I agree that there would be some benefits if the notebooks would be ordered, e.g. with a number prefix in the file name.

This is actually something that I've been considering in the past. I think there are certain tradeoffs. If the notebooks are not numbered, then adding a new notebook somewhere in between does not require renaming other notebooks - placing it in the preferred location in the README is enough. Also, my personal use case for teaching is to pick certain set of notebooks depending on the audience, which is painless as I don't have to rename any of the notebooks.

Separate index file (similar as README but would render nicely in Jupyter Notebook) would be indeed a viable solution which would not require renaming the notebooks. I'll consider this.

jerry-git commented 5 years ago

Btw, in addition to the plain README file, you can use this https://jerry-git.github.io/learn-python3/ as index.

jerry-git commented 1 year ago

Added numbering also for the filenames in https://github.com/jerry-git/learn-python3/pull/35 🙂