Skip to content

Commit 63aa6c4

Browse files
Add notes for v0.3.0-alpha release
1 parent 894a15a commit 63aa6c4

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Introducing Narcotics Tracker v0.2.5.
2+
3+
| Version | Release Date | Audience |
4+
| :------ | :----------- | :--------- |
5+
| 0.3.0 | 11/07/2022 | Developers |
6+
7+
**Message from ScottSucksAtProgramming:**
8+
9+
> Hooray! Version 0.3.0 is here! This is not a gigantic update but it marks the
10+
> completion of the primary goal I had for this project. With a single command
11+
> the Narcotics Tracker can now print out all the information required for the
12+
> NYS Semi-Annual Controlled Substance Inventory Form for EMS Agencies'
13+
> (DOH-3848). This will make reporting each period far far easier than doing it
14+
> manually.
15+
16+
## Reports Package
17+
18+
The Reports Package has been added to the main directory of the Narcotics
19+
Tracker.
20+
21+
### Interface
22+
23+
The Report Module within the Interfaces sub-package contains the protocol for
24+
reports. It is similar to the Command Protocol and is using the Command Design
25+
Pattern for its implementation. The receiver can be set via the initializer.
26+
The run method will execute the report and return the results.
27+
28+
### Return Medication Stock Report
29+
30+
This report returns the current amount of a specified medication in the
31+
inventory. Amount is currently returned as a float. This may be adjusted later
32+
to return a dictionary to conform to the other reports.
33+
34+
### Return Current Inventory
35+
36+
THis report returns the current amount of all 'active' medications in the
37+
'medications' table in the inventory. This report is designed to be used for
38+
regular inventory stock counts. Where the physical inventory count can be
39+
compared to the return value of this report. This report currently returns the
40+
data as a list of dictionaries.
41+
42+
### Bi-Annual Narcotics Inventory Report
43+
44+
This is the big guy! This will cycle through all active medications from the
45+
'medications' table and all data from the current, 'open' reporting period to
46+
return the following:
47+
48+
- Starting amount of the medication in milliliters.
49+
- Amount of the medication received from orders in milliliters.
50+
- Amount of the medication used by providers in milliliters.
51+
- Amount of the medication wasted by providers in milliliters.
52+
- Amount of the medication destroyed at a reverse distributor in milliliters.
53+
- Amount of the medication lost or stolen in milliliters.
54+
- Final amount of the medication in milliliters.
55+
56+
When adjustments are up to date, this report should be accurate and can be used
57+
to complete this report without issue.
58+
59+
## Next Up!
60+
61+
The next release will see the implementation of a command line interface! Wish
62+
me luck!

0 commit comments

Comments
 (0)