|
1 | 1 | """Tracks the inventory of controlled substances used at EMS agencies.
|
2 | 2 |
|
3 |
| -Version: 0.1.0 |
| 3 | +Version: 0.2.0 |
4 | 4 |
|
5 | 5 | Author: Scott Kostolni - (https://github.com/ScottSucksAtProgramming)
|
6 | 6 |
|
7 | 7 | Special Thanks:
|
8 | 8 | Mom, thanks for being my software design mentor and entertaining my
|
9 | 9 | onslaught of questions.
|
10 | 10 |
|
| 11 | + Tina, thank you for listening to me go on and on about this project and |
| 12 | + for reading my documentation to ensure I sound a little less like an idiot |
| 13 | + than I actually am. |
| 14 | +
|
11 | 15 | Purpose:
|
12 | 16 | Welcome to the Narcotics Tracker! This software is designed to assist
|
13 | 17 | controlled substance agents working at EMS agencies with inventory
|
|
22 | 26 | need.
|
23 | 27 |
|
24 | 28 | Current Completed Features:
|
25 |
| - Medication Module - Creates and stores medication objects in the database. |
26 |
| -
|
27 |
| - Database Module - Handles communication with the SQLite3 database. |
| 29 | + Database Object Creation - Medications, Medication Containers, Units of |
| 30 | + Measurement, Events, Inventory Adjustments, Reporting Periods and Statuses |
| 31 | + can be created using the Builder Modules for each item. |
28 | 32 |
|
29 |
| - Builders Package - Assists with the building of complex objects. |
| 33 | + Database and Table Creation - Tables have been defined for all Database |
| 34 | + Objects and can be stored. The Database Class now functions as a context |
| 35 | + manager for better resource management. |
30 | 36 |
|
31 |
| - Enums Package - Contains the enumerated types used in the software. |
| 37 | +Planned Features: |
| 38 | + Inventory Tracking (v0.2.0 - alpha) - Completed! |
32 | 39 |
|
33 |
| - Utils Package - Contains utility functions used in the software. |
| 40 | + Code Architecture Improvement (v0.2.5 - Alpha) |
34 | 41 |
|
35 |
| -Planned Features: |
36 |
| - Inventory Tracking (v0.2.0) |
| 42 | + Command Line Tools (v1.0.0) |
37 | 43 |
|
38 |
| - Lot Tracking (v0.3.0) |
| 44 | + Order Tracking (v1.1.0) |
39 | 45 |
|
40 |
| - Order Tracking (v0.4.0) |
| 46 | + Lot Tracking (v1.2.0) |
41 | 47 |
|
42 |
| - Destruction Tracking (v0.5.0) |
| 48 | + Destruction Tracking (v1.3.0) |
43 | 49 |
|
44 |
| - User and Agent Management (v0.6.0) |
| 50 | + User and Agent Management (v1.4.0) |
45 | 51 |
|
46 |
| - Report Generation (v0.7.0) |
| 52 | + Report Generation (v1.5.0) |
47 | 53 |
|
48 |
| - Console Interface (v0.8.0) |
| 54 | + Console Interface (v1.6.0) |
49 | 55 |
|
50 |
| - GUI Interface (v1.0.0) |
| 56 | + GUI Interface (v1.7.0) |
51 | 57 |
|
52 | 58 | Packages:
|
53 | 59 | Builders: Assists with the building of complex objects.
|
54 | 60 |
|
55 |
| - Enums: Contains the enumerated types used in the software. |
| 61 | + Enums: Package Removed in v0.2.0 - alpha. |
| 62 | +
|
| 63 | + Setup: Contains standard items for populating the database. |
56 | 64 |
|
57 | 65 | Utils: Contains utility functions used in the software.
|
58 | 66 |
|
59 | 67 | Modules:
|
60 |
| - Database: Handles communication with the SQLite3 database. |
61 | 68 |
|
62 |
| - Medication: Creates and stores medication objects in the database. |
| 69 | + Containers: Contains implementation and representation of Medication |
| 70 | + Containers. |
| 71 | +
|
| 72 | + Database: Defines the database model for the narcotics tracker. |
| 73 | +
|
| 74 | + Events: Contains the implementation and representation of Events. |
| 75 | +
|
| 76 | + Inventory: Contains the implementation and representation of Inventory |
| 77 | + Adjustments. |
| 78 | +
|
| 79 | + Medications: Contains the implementation and representation of Medication |
| 80 | + Objects. |
| 81 | +
|
| 82 | + Reporting Periods: Contains the implementation and representation of |
| 83 | + Reporting Period Objects. |
| 84 | +
|
| 85 | + Statuses: Contains the implementation and representation of Object |
| 86 | + Statuses. |
| 87 | +
|
| 88 | + Units: Contains implementation and representation of Units of Measurement. |
| 89 | +
|
| 90 | +
|
| 91 | +Release Notes: |
| 92 | +
|
| 93 | +Version 0.1.0 - https://github.com/ScottSucksAtProgramming/narcotics_tracker/releases/tag/v0.1.0-alpha |
| 94 | +
|
| 95 | +Version 0.2.0 - https://github.com/ScottSucksAtProgramming/narcotics_tracker/releases/tag/v0.2.0-alpha |
63 | 96 | """
|
0 commit comments