diff --git a/.gitignore b/.gitignore index a9acf9f..082bf82 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ # Ignore python environment files env-inv-doc/ -env/ \ No newline at end of file +env/ + +# Compiled python files +*.pyd +*.pyc \ No newline at end of file diff --git a/__pycache__/main.cpython-38.pyc b/__pycache__/main.cpython-38.pyc deleted file mode 100644 index 00b6e4b..0000000 Binary files a/__pycache__/main.cpython-38.pyc and /dev/null differ diff --git a/docs/app/part.md b/docs/app/part.md index a381e49..fc8764a 100644 --- a/docs/app/part.md +++ b/docs/app/part.md @@ -4,7 +4,7 @@ title: Part Views ## Part Category View -From the *home screen*, select *Parts* to open the top-level part category display. +From the *home screen*, select *Parts* to open the top-level part category view. ### Detail Tab diff --git a/docs/app/stock.md b/docs/app/stock.md index d49f7a9..d3017d6 100644 --- a/docs/app/stock.md +++ b/docs/app/stock.md @@ -2,21 +2,142 @@ title: Stock Views --- -## InvenTree App Stock Views +## Stock Location View -!!! todo "TODO" - This section requires further work +From the *home screen*, select *Stock* to open the top-level stock location view. -## Stock Item +### Details Tab -### Details +The *Details* tab shows information about the selected stock location. -### Actions +{% with id="loc-detail", url="location_detail.jpg" %} +{% include "app_img.html" %} +{% endwith %} -## Stock Location +#### Parent Location -### Details +If the current location has a parent location (i.e. it is not a top-level location) then a link is provided to the parent location. Tap the *parent location* tile to navigate to the location detail page for the parent location. -### Actions +#### Sublocations -## Search \ No newline at end of file +If the current stock location has any sublocations, they are listed here. Select any of the displayed sublocations to navigate to the detail view. + +### Stock Tab + +The *Stock* tab displays all the stock items available in this location. Tap a displayed stock item to navigate to the stock item detail view. + +{% with id="loc-stock", url="location_stock.jpg" %} +{% include "app_img.html" %} +{% endwith %} + + +The list of available stock items can be filtered using the input box at the top of the screen: + +{% with id="loc-filter", url="location_stock_filter.jpg" %} +{% include "app_img.html" %} +{% endwith %} + + +### Actions Tab + +The *Actions* tab displays the available actions for the selected location: + +{% with id="loc-actions", url="location_actions.jpg" %} +{% include "app_img.html" %} +{% endwith %} + + +#### New Location + +Create a new location under the current location: + +{% with id="loc-new", url="new_location.jpg" %} +{% include "app_img.html" %} +{% endwith %} + + +#### New Stock Item + +Create a new stock item in the current location: + +{% with id="loc-new-stock", url="new_stock_item_from_location.jpg" %} +{% include "app_img.html" %} +{% endwith %} + + +#### Scan Stock Items Into Location + +Use the barcode scanner to scan a stock item into the current location. + + +## Stock Item Detail View + +The *Stock Item Detail* view displays information about a single stock item: + +{% with id="stock-detail", url="stock_detail.jpg" %} +{% include "app_img.html" %} +{% endwith %} + + +### Details Tab + +The *details* tab shows information about the selected stock item. Some of the displayed tiles provide further information when selected: + +#### Part Tile + +Part information is displayed at the top of the screen. Tap on this tile to navigate to the detail view for the linked part + +#### Location + +Tap on the location tile to navigate to the location detail view + +#### Notes + +Tap on the notes tile to display and edit the notes for this stock item + +### Actions Tab + +The *actions* tab displays the available actions for the selected stock item: + +{% with id="stock-actions", url="stock_actions.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +#### Count Stock + +Select the *Count Stock* action to validate the current number of items in stock. Use this option to perform a quick stocktake! + +!!! info "Serialized Stock" + The *count stock* action is not available for serialized stock items, as they have a fixed quantity of 1 + +#### Remove Stock + +Select this action to remove a certain quantity from the selected stock item. For example, if there are 12 items available, and you take 3 items, the listed quantity will be reduced to 9 itemes. + +#### Add Stock + +Select this action to add a certain quantity to the selected stock item. For example, if there are 12 items available, and you add 3 items, the listed quantity will be increased to 15 items. + +#### Transfer Stock + +Transfer (move) the stock item to a new location + +#### Scan Into Location + +Transfer the stock item into a new location by scanning the barcode for that location. If a *valid* stock location barcode is scanned, the stock item will be automatically relocated to that location + +#### Assign Barcode + +If a stock item has a third-party barcode (i.e. it has been received from a supplier with a barcode already printed) then this barcode can be used to track the stock item in InvenTree. + +Select the *assign barcode* action to scan this third-party barcode and assign it to this stock item. + +This barcode can then be used to track the stock item. + +### Edit Stock Item + +To edit the stock item details, select the *Edit* button in the top right corner of the screen: + +{% with id="stock-edit", url="stock_edit.jpg" %} +{% include "app_img.html" %} +{% endwith %} \ No newline at end of file diff --git a/docs/assets/images/app/location_actions.jpg b/docs/assets/images/app/location_actions.jpg new file mode 100644 index 0000000..3b79aed Binary files /dev/null and b/docs/assets/images/app/location_actions.jpg differ diff --git a/docs/assets/images/app/location_detail.jpg b/docs/assets/images/app/location_detail.jpg new file mode 100644 index 0000000..ff4d917 Binary files /dev/null and b/docs/assets/images/app/location_detail.jpg differ diff --git a/docs/assets/images/app/location_stock.jpg b/docs/assets/images/app/location_stock.jpg new file mode 100644 index 0000000..e5f1efa Binary files /dev/null and b/docs/assets/images/app/location_stock.jpg differ diff --git a/docs/assets/images/app/location_stock_filter.jpg b/docs/assets/images/app/location_stock_filter.jpg new file mode 100644 index 0000000..98a91f4 Binary files /dev/null and b/docs/assets/images/app/location_stock_filter.jpg differ diff --git a/docs/assets/images/app/new_location.jpg b/docs/assets/images/app/new_location.jpg new file mode 100644 index 0000000..cee3a89 Binary files /dev/null and b/docs/assets/images/app/new_location.jpg differ diff --git a/docs/assets/images/app/new_stock_item_from_location.jpg b/docs/assets/images/app/new_stock_item_from_location.jpg new file mode 100644 index 0000000..52aac3d Binary files /dev/null and b/docs/assets/images/app/new_stock_item_from_location.jpg differ diff --git a/docs/assets/images/app/stock_actions.jpg b/docs/assets/images/app/stock_actions.jpg new file mode 100644 index 0000000..aca383b Binary files /dev/null and b/docs/assets/images/app/stock_actions.jpg differ diff --git a/docs/assets/images/app/stock_detail.jpg b/docs/assets/images/app/stock_detail.jpg new file mode 100644 index 0000000..d0f8bd3 Binary files /dev/null and b/docs/assets/images/app/stock_detail.jpg differ diff --git a/docs/assets/images/app/stock_edit.jpg b/docs/assets/images/app/stock_edit.jpg new file mode 100644 index 0000000..39f0ca2 Binary files /dev/null and b/docs/assets/images/app/stock_edit.jpg differ