Skip to content

Commit 7c77281

Browse files
Update Documentation
1 parent acc6563 commit 7c77281

File tree

4 files changed

+56
-22
lines changed

4 files changed

+56
-22
lines changed

narcotics_tracker/__init__.py

Lines changed: 52 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
"""Tracks the inventory of controlled substances used at EMS agencies.
22
3-
Version: 0.1.0
3+
Version: 0.2.0
44
55
Author: Scott Kostolni - (https://github.com/ScottSucksAtProgramming)
66
77
Special Thanks:
88
Mom, thanks for being my software design mentor and entertaining my
99
onslaught of questions.
1010
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+
1115
Purpose:
1216
Welcome to the Narcotics Tracker! This software is designed to assist
1317
controlled substance agents working at EMS agencies with inventory
@@ -22,42 +26,71 @@
2226
need.
2327
2428
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.
2832
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.
3036
31-
Enums Package - Contains the enumerated types used in the software.
37+
Planned Features:
38+
Inventory Tracking (v0.2.0 - alpha) - Completed!
3239
33-
Utils Package - Contains utility functions used in the software.
40+
Code Architecture Improvement (v0.2.5 - Alpha)
3441
35-
Planned Features:
36-
Inventory Tracking (v0.2.0)
42+
Command Line Tools (v1.0.0)
3743
38-
Lot Tracking (v0.3.0)
44+
Order Tracking (v1.1.0)
3945
40-
Order Tracking (v0.4.0)
46+
Lot Tracking (v1.2.0)
4147
42-
Destruction Tracking (v0.5.0)
48+
Destruction Tracking (v1.3.0)
4349
44-
User and Agent Management (v0.6.0)
50+
User and Agent Management (v1.4.0)
4551
46-
Report Generation (v0.7.0)
52+
Report Generation (v1.5.0)
4753
48-
Console Interface (v0.8.0)
54+
Console Interface (v1.6.0)
4955
50-
GUI Interface (v1.0.0)
56+
GUI Interface (v1.7.0)
5157
5258
Packages:
5359
Builders: Assists with the building of complex objects.
5460
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.
5664
5765
Utils: Contains utility functions used in the software.
5866
5967
Modules:
60-
Database: Handles communication with the SQLite3 database.
6168
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
6396
"""

narcotics_tracker/database.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
"""
1515

1616

17-
import os, sqlite3
17+
import os
18+
import sqlite3
1819

1920
from narcotics_tracker import (
2021
containers,

narcotics_tracker/events.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Contains the implementation and representation of events.
1+
"""Contains the implementation and representation of Events.
22
33
#* Background
44

narcotics_tracker/inventory.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Contains the implementation and representation of inventory adjustments.
1+
"""Contains the implementation and representation of Inventory Adjustments.
22
33
#* Background
44

0 commit comments

Comments
 (0)