Introduction

First Chapter

So, I will start off by mentioning the whole purpose of this wiki. This has been written with the intention to learn how to write documentation for a big project and also to enable deeper understanding of software engineering concepts with Python. I have done(am doing) something similar with Java and JavaScript.

The project itself is not build for production, but it is build for other developers and software engineers to interact with and play with. As this is a learning experience, it will be structure exactly, or almost exactly as how a Python module is structured for production. I will detail how the project structure in the next chapter.

Also, it will contain several concepts often faced in the programming or software development world from data structures to data science. Most of the code is re-useable and thus can be used in production applications and they come with tests which can be built upon. This is to ensure that quality code is always tested and is always ready for use.

Code guidelines have been followed to the letter. Which means PEP8 standards are upheld and adhered to at all times. This is Python, so it has to remain Pythonic. In addition, I have and will continue to make it such that all the systems in place to write this code is clean and automatic, which means whenever a new module is made, it will be recorded as a required module and tests will be put in place alongside a meaningful README.md which will help the user know what is going on behind the scenes.

Of course there is still much to work on and my goal will be to make this as clean and as re-useable as it possibly can be. Another goal is to ensure that this code can remain relevant and re-useable in real-life applications, thus hastening the pace of development in overall.