diff --git a/documents/references.md b/documents/references.md index 3a9546c4f43ae0f39890f842c35ae30f2a3f7b7a..27b5941ac40f3620ede9517726c7767e447b7a4a 100644 --- a/documents/references.md +++ b/documents/references.md @@ -8,6 +8,21 @@ All references to external logic. Includes anything from stack overflow links to ## New References References new to this project. +### Python Project as a Library +Various recommendations for using a project as a library for other projects: +* Don't configure extra handlers inside the library: <https://docs.python-guide.org/writing/logging/> +* General Library Rules, Mostly Concerning \_\_init\_\_.py: +<https://axialcorps.wordpress.com/2013/08/29/5-simple-rules-for-building-great-python-packages/> +* Many Recommendations for Project Structure: <https://docs.python-guide.org/writing/structure/> +* Extended Info on Logging: <https://docs.python.org/3/howto/logging.html#logging-advanced-tutorial> +<https://stackoverflow.com/questions/15727420/using-python-logging-in-multiple-modules> + +### Git Submodules +Since I don't know how Python projects are exported to be a pip library (and I'm not even sure if that's a good use case +for this project), it's being set up as a submodule project for now. +* General Info About Git Submodules: <https://github.blog/2016-02-01-working-with-submodules/> +* Importing a Submodule to a Specific Subdirectory: <https://stackoverflow.com/a/12012292> + ### Nested Classes I felt like the 3 "functions" from our book Algorithm seemed complicated enough to each be separate entities on their own. Rather than trying to cram all the logic into one large class, I decided to look into splitting each function into