Finalize documentation for v0.2.5 alpha release

Author: ScottSucksAtProgramming

narcotics_tracker/__init__.py

@@ -1,7 +1,7 @@
 """Tracks the inventory of controlled substances used at EMS agencies.
 
 #* Title: Narcotics Tracker
-#* Version: 0.2.0
+#* Version: 0.2.5
 #* Author: Scott Kostolni - (https://github.com/ScottSucksAtProgramming)
 
 #*  Special Thanks:
@@ -30,20 +30,42 @@
 
 #*  Current Completed Features:
 
-    Database Object Creation - Medications, Medication Containers, Units of 
-    Measurement, Events, Inventory Adjustments, Reporting Periods and Statuses 
-    can be created using the Builder Modules for each item.
-
-    Database and Table Creation - Tables have been defined for all Database 
-    Objects and can be stored. The Database Class now functions as a context 
-    manager for better resource management.
+    Custom Object Creation - Medications, Units of Measurement, Events, 
+    specific Inventory Adjustments, Reporting Periods and Statuses can be 
+    created allowing any EMS agency to customize the Narcotics Tracker to 
+    their policies and procedures. These objects are collectively referred to 
+    as DataItems as they are items which live in the database.
+
+    Persistent Storage - The built-in SQLite3 Database library has been used 
+    as the main data repository for the Narcotics Tracker. Tables have been 
+    created to for each of the six DataItems. The Inventory Table serves as 
+    the main table for the database;  It tracks each individual change to the 
+    stock of a medication, called an Adjustment. Adjustments use data stored 
+    in the Events Table, among others, to calculate how the adjustment affects 
+    the stock and which medications are affected by it. The Medications Table 
+    stores information on the controlled substances used by an EMS agency 
+    including their concentration and preferred unit of measurement. These 
+    data points are used to tally medication totals and calculate data 
+    required when reporting to oversight agencies.
+    
+    Utility Services - Multiple utilities are used to manage the inventory of 
+    controlled substances. The Service Provider feature provides quick and 
+    easy access to these services and provides an interface that new services 
+    can make use of without requiring changes to the code that relies on a 
+    service.
+
+    Flexible Design and Architecture - In the most recent update, the 
+    structure of the Narcotics Tracker was rebuilt from the ground up to 
+    improve the readability of the code and reduce its fragility. As a result 
+    the code is well structured, easier to work with, and much more 
+    extensible.
 
 #*  Planned Features:
 
     #✓ Medications and Initial Development (v0.1.0 - Alpha) - Completed!
     #✓ Inventory Tracking (v0.2.0 - Alpha) - Completed!
-    #Todo Code Architecture Improvement (v0.2.5 - Alpha) - In Progress
-    #! Basic Report Generation (v0.3.0 - Alpha)
+    #✓ Code Architecture Improvement (v0.2.5 - Alpha) - Completed!!
+    #TODO Basic Report Generation (v0.3.0 - Alpha) - Next Up!!
     #! Command Line Tools (v0.0.0 - Beta)
     #! Order Tracking (v0.1.0 - Beta)
     #! Lot Tracking (v0.2.0 - Beta)
@@ -53,27 +75,70 @@
     #! Console Interface (v0.6.0)
     #! GUI Interface (v0.7.0)
 
-#*  Packages:
+#*  Meet the Players:
+
+    #* DataItems and Builders
+
+        DataItems are individual objects which are stored in the database and 
+        enable inventory management. They contain numerous attributes and the 
+        Builder Design Pattern was used to help make constructing DataItems 
+        easier. Each DataItem has its own builder which provides a step-wise 
+        approach to assigning attributes and constructing the object. In 
+        future updates Director Objects will be provided to walk end users 
+        through the creation of DataItems.
+
+        - Adjustments record specific changes to the stock of a medication.
+
+        - Events classify the types of changes which commonly occur and 
+            determine if amounts are added or removed from the stock.
+
+        - Medications store relevant information about the controlled 
+            substances. Adjustments must specify which medication(s) were 
+            affected.
+
+        - Reporting Periods allow for adjustments to be organized by their 
+            date and are used to determine which adjustments need to be 
+            reported.
+
+        - Statuses provide additional information for Medications, Reporting 
+            Periods and future additions to the Narcotics Tracker.
+
+        - Units store information on how a medication is measured and are 
+            integral to completing reports for oversight agencies.
+
+    #* The Services
+
+        Services provide utilities to help with the management of the 
+        narcotics inventory. The Service Provider offers an easy way for these 
+        services to be accessed.
+
+        - The Persistence Service communicates directly with the SQLite 
+            database. It stores items in the appropriate tables returns 
+            requested data.
+
+        - The DateTime Service provides date and time information and converts 
+            between human readable dates and the unix timestamps which are 
+            stored in the database.
 
-    Builders: Contains the builders for the DataItems used in the 
-        Narcotics Tracker.
-    Items: Contains the items which are stored in the database.
-    Scripts: Contains various scripts which help to setup and use the 
-        Narcotics Tracker.
-    Setup: Contains the modules needed to set up the Narcotics Tracker 
-        software.
-    Utils: Contains utility helper modules and functions.
+        - The Conversion Service converts medication amounts between various 
+            units of mass and volume.
 
-#*  Modules:
+    #* Commands
 
-    Commands: Contains the commands for the SQLite3 Database.
-    Database: Manages Communication with the SQLite3 Database.
-    SQlite3 Interface: Defines the protocol for commands which interact with 
-        the SQLite3 database.
+        In order to increase the flexibility of the Narcotics Tracker the 
+        Command Design Pattern was implemented. Commands provide access to 
+        simple and complex activities through a shared interface. 
+        
+        Each command allows for the specification of its intended receiver 
+        during initialization. To trigger the command its 'execute' method is 
+        called. Any required information can be passed into the execute method 
+        which will pass it on to its target to complete the command. 
+        Additional commands can be easily created using this interface.
 
 
 #*  Release Notes:
 
         Version 0.1.0 - https://github.com/ScottSucksAtProgramming/narcotics_tracker/releases/tag/v0.1.0-alpha
         Version 0.2.0 - https://github.com/ScottSucksAtProgramming/narcotics_tracker/releases/tag/v0.2.0-alpha
+        Version 0.2.5 - https://github.com/ScottSucksAtProgramming/narcotics_tracker/releases/tag/v0.2.5-alpha
 """