Merge branch 'master' of github.coventry.ac.uk:CUEH/py-quickstart

docs/ads/README.md

@@ -0,0 +1,8 @@
+# Abstract Data Structures
+
+{{todo("Write this section")}}
+
+
+    Trees
+    Graphs
+    Sets

docs/algorithms/README.md

@@ -0,0 +1,10 @@
+# Algorithms
+
+{{todo("Write this section")}}
+
+
+    What is an algorithm?
+    Efficiency
+        Test Your Knowledge: Recursive Fibonacci
+    Searching
+    Sorting

docs/data/README.md

@@ -0,0 +1,12 @@
+# Representation of Data
+
+{{todo("Write this section")}}
+
+
+
+    Bytes, Characters and Byte Strings
+    Bases
+    Binary
+    Hex
+    ASCII, Unicode, UTF-8
+    Base64

docs/documentation/README.md

@@ -0,0 +1,12 @@
+# Documentation
+
+{{todo("Write this section")}}
+
+
+
+Docstrings
+
+
+Comments
+
+PDoc (probably)

docs/git/README.md

@@ -0,0 +1,10 @@
+# Version Control
+
+{{todo("Write this section")}}
+
+
+
+    Git
+    Creating a repository
+    Staging, committing and pushing
+

docs/index.md

@@ -1,124 +1,14 @@
 # Introduction
+{{todo("""Intro""")}}
 
-{{ todo("Insert introduction, explaining the expectation, about the 'test your knowledge' tasks, etc.") }}
+## How to use this repository
+{{todo("""Explain that the repo is roughly in expected order, tied to programming content on the Ethical Hacking course, but can be used as a reference
 
+Also mention:
 
-<!-- 1 to 6, download -->
+1. Test your knowledge
+2. Code samples
+3. How to suggest edits and get your name in the credits
 
-<!-- {{ code_from_file("values-and-types/example-1.py", 1, 6, download=True) }} -->
-
-<!-- Flavour is python, exec -->
-
-<!-- {{ code_from_file("values-and-types/example-1.py", flavor = "python", execute=True, download=True) }} -->
-
-<!-- 2 to 5 -->
-
-<!-- {{ code_from_file("values-and-types/example-1.py", 2, 5) }} -->
-
-<!-- to 5 -->
-
-<!-- {{ code_from_file("values-and-types/example-1.py", stop = 5) }} -->
-
-<!-- 2 to 5, bash -->
-
-<!-- {{ code_from_file("values-and-types/example-1.py", 2, 5, "bash") }} -->
-
-
-# Contents
-* Version Control
-	* Git
-	* Creating a repository
-	* Staging, committing and pushing
-
-* [Variables and state](./values-and-types/README.md)
-	* [Data Types](./values-and-types/README.md#values-and-types)
-	* [Assignment](./values-and-types/README.md#basic-types-creating-your-first-variable)
-	* [Naming Conventions](./values-and-types/README.md#naming-conventions)
-	* [Test your Knowledge: Probabilities](./values-and-types/README.md#test-your-knowledge)
-
-* [Statements and Expressions](./conditionals/README.md)
-	* [Evaluation](./conditionals/README.md#evaluation)
-	* [Order of Precedence](./conditionals/README.md#order-of-precedence)
-	* [Literal Values](./conditionals/README.md#literal-values)
-	* [Boolean Logic](./conditionals/README.md#boolean-logic)
-	* [Inequalities](./conditionals/README.md#inequalities)
-
-* Testing
-	* PyTest
-	* Unit Testing
-	* Regression Testing
-	* Integration Testing
-	* Test Your Knowledge: Bug Hunt (broken code they have to fix)
-
-* Selection
-	* [If](./conditionals/README.md#If)
-  	* [Else](./conditionals/README.md#Else)
-	* [Elif](./conditionals/README.md#elif)
-* Iteration
-	* [For](./iteration/for-loops/README.md)
-		* [Test Your Knowledge: Countdown](./iteration/for-loops/README.md#test-your-knowledge-countdown)
-	* [While](./iteration/while-loops/README.md)
-		* [Test Your Knowledge: Fibonacci](./iteration/while-loops/README.md#test-your-knowledge)
-	* [Break](./iteration/control-statements/README.md#break)
-	* [Continue](./iteration/control-statements/README.md#continue)
-	* Test Your Knowledge: They Came From Space (or other game)
-
-* [Functions](./functions/intro-to-functions)
-	* Function Syntax
-	* Returning Values
-	* Parameters
-	* Yield
-	* Lambda functions
-	* Passing functions
-
-
-* Documentation
-	* Docstrings
-	* PyDoc (probably)
-
-* Representation of Data
-	* Bytes, Characters and Byte Strings
-	* Bases
-	* Binary
-	* Hex
-	* ASCII, Unicode, UTF-8
-	* Base64
-
-
-* Algorithms
-	* What is an algorithm?
-	* Efficiency
-		* Test Your Knowledge: Recursive Fibonacci 
-	* Searching
-	* Sorting
-
-* Classes and Objects
-	* Object-Oriented Programming
-	* Classes
-	* Objects
-	* Object properties and functions
-	* Class properties and functions
-* Interacting with the Network
-	* Requests
-	* Sockets
-	* Scapy
-	* Beautiful Soup
-
-* Modules and Packages
-
-
-* Abstract Data Structures
-	* Trees
-	* Graphs
-	* Sets
-* Low-Level Programming
-	* Assembly Language
-	* Interrupts
-	* Memory Organisation and Architecture
-	* The Stack 
-	* The Heap
-		* Now Try: Core Wars
-
-* Functional programming
-???
+""")}}
 

docs/lowlevel/README.md

@@ -0,0 +1,10 @@
+# Low-Level Programming
+
+{{todo("Write this section")}}
+
+    Assembly Language
+    Interrupts
+    Memory Organisation and Architecture
+    The Stack
+    The Heap
+        Now Try: Core Wars

docs/modules/README.md

@@ -0,0 +1,3 @@
+# Modules and Packages
+
+{{todo("Write this section")}}

docs/network/README.md

@@ -0,0 +1,8 @@
+# Interacting with the Network
+
+{{todo("Write this section")}}
+
+    Requests
+    Sockets
+    Scapy
+    Beautiful Soup

docs/oo/README.md

@@ -0,0 +1,9 @@
+# Objects and Classes
+
+{{todo("Write this section")}}
+
+    Object-Oriented Programming
+    Classes
+    Objects
+    Object properties and functions
+    Class properties and functions

docs/testing/README.md

@@ -0,0 +1,15 @@
+# Testing
+
+{{todo("Write this section")}}
+
+
+
+PyTest
+
+Unit Testing
+
+Regression Testing
+
+Integration Testing
+
+Test Your Knowledge: Bug Hunt (broken code they have to fix)

mkdocs.yml

@@ -1,7 +1,8 @@
 site_name: Python for Hackers - Quick Start
 
 nav:
-  - home: index.md
+  - Introduction: index.md
+  - 'Version Control': 'git/'
   - 'Development Environment':
     - 'TODO - Files and Directories (types, shebang)': ./
     - 'TODO - Virtual Environments': ./
@@ -18,7 +19,15 @@ nav:
     - 'Introduction to functions': 'functions/intro-to-functions.md'
     - 'User created functions': 'functions/user-functions/README.md'
     - 'Built-in functions': 'functions/built-in-functions/README.md'
-
+  - 'Tetsing': 'testing/'
+  - 'Documentation': 'documentation/'
+  - 'Representation of Data': './data/'
+  - 'Algorithms': 'algorithms/'
+  - 'Classes and Objects': 'oo/'
+  - 'Interacting with the Network': 'network/'
+  - 'Modules and Packages': 'modules/'
+  - 'Abstract Data Structures': 'ads/'
+  - 'Low-Level Programming': 'lowlevel/'
 
 markdown_extensions:
   - admonition          ## see: https://squidfunk.github.io/mkdocs-material/extensions/admonition/ for usage 

requirements.txt

@@ -5,4 +5,4 @@ markdown-blockdiag
 WeasyPrint
 mkdocs-pdf-export-plugin 
 mkdocs-macros-plugin
-
+markdown