Code Monkey home page Code Monkey logo

audit-tools's Introduction

Cova Dispensary POS Audit Tools

PyPI - Python Version PyPI Testing Python package

An inventory audit tool for speeding up inventory and avoiding errors that occur during processing. This tool will allow users to complete inventory counts with a simple workflow that remedies user error.

Installation and Usage

$ pypi install audit-tools
from audit_tools.sessionmanager import SessionManager

with SessionManager() as session:  # invokes the session manager

  session.import_data("/path/to/file.xlsx")  # imports data from an excel, json or csv file

  session.count_product('F7X6A7', 20)  # Counts 20 F7X6A7's to the inventory
  session.increase_product('F7X6A7', 10)  # Increases F7X6A7 to 30 in the inventory
  session.reduce_product('F7X6A7', 3)  # Reduces F7X6A7 to 27 in the inventory

  print(session.get_product('F7X6A7'))  # Returns the row of product with SKU 'F7X6A7'

  session.parse_session_data()  # Updates session dataframes with accurate content

Session Manager

The session manager is the main class that manages the session. It is responsible for importing data, counting products, and updating the session dataframes. It will take products when SessionManager() is called or when the import_data() method is called.

Testing - will make sure that there is no output file

from audit_tools.sessionmanager import SessionManager

with SessionManager('/path/to/file.xlsx', testing=True) as session:
  session.import_data('/path/to/file.xlsx')

Scanner

Not working on it, do not use just there for testing and proof of concept

from audit_tools.sessionmanager import SessionManager
from audit_tools.core.utils.scanner import Scanner

with SessionManager('/path/to/file.xlsx') as session:
  # Usage of the scanner is discouraged as it is not thread safe or efficient
  # Scanner is mostly for testing purposes
  # I do not update the code often in the scanner

  scanner = Scanner(session)  # Creates a scanner object

  scanner.start_count()  # Starts the count process

  scanner.shutdown()  # processes and saves session data to disk

Problems

All the problems that we encounter while processing inventory data during an audit.

  • Extremely slow
  • Miscounts often occur
  • Redundant item checks
  • Manual data entry
  • User error

Solutions

Our ideas for solution implementations for fixing these problems so that an Audit can be completed successfully with accuracy and speed.

  • Session Manager

    • Allows users to start a new session with a products csv or xlsx file. The session manager will process all incoming products and append them to the sessions DataFrame, when you shut down the session manager will parse all the data in the session, complete variance calculations, raise any alerts, and save the session to the updated csv or xlsx file.
  • Scan & Count

    • Allows users to scan a SKU and count the number of products to update the session file.
  • Scan & Edit

    • Allows user to scan a SKU adn manage the data entry for a specified product in the session.
  • Receipt Parser

    • Allows user to upload scan a receipt and the system will parse the receipt and update the session file.

Feature List

This list will include all the features, current and future.

Features Working Status
Session Manager Working*
Scan & Count In Development
Scan & Edit Planned
Receipt Parser Planned

Dev notes: If you come across this project, I am a newish developer, and I am not familiar with the python ecosystem especially poetry. If you are confused on the namings in this project, keep in mind this package was created for a sole reason to help the creator at work, and will be used in tandem with a handheld scanner.

audit-tools's People

Contributors

jakepixl avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.