Skip to main content

License: MIT PyPI PEP

Rolling Stocktake Plugin

This is as plugin for InvenTree which provides integration of rolling stocktake for InvenTree.

Description

Rolling stocktake is a method of inventory management where a small subset of inventory is counted on a regular basis, rather than counting the entire inventory at once. This plugin provides tools to facilitate rolling stocktake operations within InvenTree.

Features

The plugin provides the following features:

  • A backend API endpoint to retrieve items which are due for stocktake
  • A frontend interface to view and manage rolling stocktake operations
  • Automatic daily marking of stale stock items as requiring stocktake

Dashboard Widget

Users are presented with a custom widget on their dashboard, which automatically fetches a single stock item which is due for stocktake:

Dashboard Widget

This widget allows users to quickly and easily perform stocktake operations on individual items. Once stocktake has been performed on a given item, the next item which is due for stocktake is automatically fetched.

Installation

Install the plugin using the methods described below.

Note: After the plugin is installed, it must be activated via the InvenTree plugin interface.

Via User Interface

Installation via the InvenTree plugin manager is the recommended approach:

The simplest way to install this plugin is from the InvenTree plugin interface. Enter the plugin name (inventree-rolling-stocktake) and click the Install button:

Install Plugin

Via Pip

To install manually via the command line, run the following command:

pip install rolling-stocktake

Note: You must be operating within the InvenTree virtual environment!

Automatic Stale Marking

The plugin runs a daily background task that automatically marks stock items as requiring stocktake. An item is considered stale when:

  • It was created before the configured Stale Period threshold, and
  • It has not been counted since the same threshold (or has never been counted)

Stale items are assigned the configured Stale Status stock status code. This makes them easy to identify and prioritise in the dashboard widget and elsewhere.

Note: If the Stale Status setting is not configured (left blank), the automatic marking function will not run. Both the Stale Status and Stale Period settings must be set for this feature to take effect.

Items that are already assigned the stale status, are located in external locations (if Ignore External Locations is enabled), or belong to inactive parts (if Ignore Inactive Parts is enabled) are excluded from processing.

Configuration

The plugin can be configured via the InvenTree plugin interface. The following settings are available:

Setting Description
Allowed Group Specify a group which is allowed to perform rolling stocktake operations. Leave blank to allow all users.
Weekly Limit Maximum number of stock items a user can count in a single week.
Random Pool Number of candidates to randomly select from when choosing the next item (0 = always pick the oldest).
Ignore External Locations Ignore stock items which are located in external locations.
Ignore Inactive Parts Ignore stock items which belong to inactive parts.
Display Creature Display a creature on the dashboard widget when there are items to be counted.
Stale Period Number of days after which an uncounted stock item is considered stale.
Stale Status Stock status code applied to items identified as stale. Leave blank to disable automatic stale marking.

Plugin Settings

Metadata

Release files for inventree-rolling-stocktake 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for inventree-rolling-stocktake 0.3.0
File Size Uploaded Provenance Actions
inventree_rolling_stocktake-0.3.0.tar.gz 251.3 kB Without provenance Details for inventree_rolling_stocktake-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for inventree-rolling-stocktake 0.3.0
File Interpreter ABI Platform Actions
inventree_rolling_stocktake-0.3.0-py3-none-any.whl Python 3 none any Details for inventree_rolling_stocktake-0.3.0-py3-none-any.whl

Total release size: 518.5 kB

Release files / inventree_rolling_stocktake-0.3.0.tar.gz

Download URL inventree_rolling_stocktake-0.3.0.tar.gz
Size 251.3 kB
Tags Source
SHA-256 checksum
How to use checksums
4e314a4164cd7deee595a11fa9617a85b315fc9f357eb136bc2c00c3333fb49d
BLAKE2b-256 checksum
How to use checksums
75a5897ae3a0df93759b26bbcd8b40c1ee63bed6586397d1d72f63502c7a5c10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / inventree_rolling_stocktake-0.3.0-py3-none-any.whl

Download URL inventree_rolling_stocktake-0.3.0-py3-none-any.whl
Size 267.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ec794d5eb75d295ee83dd73b595aa2820f8d513b208d27c2334e6873702856ac
BLAKE2b-256 checksum
How to use checksums
802ddc2c52006f9bb96e8777b759dcfd395f50ba25094ea65091500d8df7bbe0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Security for inventree-rolling-stocktake 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page