From a0c91203b0d83337a7a325e002c520e98f53374e Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Tue, 24 Nov 2020 21:26:40 +1100 Subject: [PATCH 1/8] Change "invoke" -> "inv" --- docs/start/config.md | 4 ++-- docs/start/deploy.md | 6 +++--- docs/start/install.md | 14 +++++++------- docs/start/migrate.md | 8 ++++---- docs/start/update.md | 2 +- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/start/config.md b/docs/start/config.md index 0da0208..fb89f97 100644 --- a/docs/start/config.md +++ b/docs/start/config.md @@ -40,7 +40,7 @@ MySQL database backend is supported with the native Django implemetation. To run To install these required packages, run the following command: ``` -invoke mysql +inv mysql ``` It is then up to the database adminstrator to create a new MySQL database to store inventree data, in addition to a username/password to access the data. @@ -61,7 +61,7 @@ PostgreSQL database backend is supported with the native Django implementation. To install these required packages, run the following commands: ``` -invoke postgresql +inv postgresql ``` It is then up to the database adminstrator to create a new PostgreSQL database to store inventree data, in addition to a username/password to access the data. diff --git a/docs/start/deploy.md b/docs/start/deploy.md index 173cc17..4d94b17 100644 --- a/docs/start/deploy.md +++ b/docs/start/deploy.md @@ -19,7 +19,7 @@ The InvenTree development server is useful for testing and configuration - and i To run the development server on a local machine, run the command: ``` -invoke server -a 127.0.0.1:8000 +inv server -a 127.0.0.1:8000 ``` Serving on the address `127.0.0.1` means that InvenTree will only be available *on that computer*. The server will be accessible from a web browser on the same computer, but not from any other computers on the local network. @@ -29,7 +29,7 @@ Serving on the address `127.0.0.1` means that InvenTree will only be available * To enable access to the InvenTree server from other computers on a local network, you need to know the IP of the computer running the server. For example, if the server IP address is `192.168.120.1`: ``` -invoke server -a 192.168.120.1:8000 +inv server -a 192.168.120.1:8000 ``` !!! warning "Not For Production" @@ -59,7 +59,7 @@ Directories for storing *media* files and *static* files should be specified in The required static files must be collected into the specified ``STATIC_ROOT`` directory: ``` -invoke static +inv static ``` This command collects all of the required static files (including script and css files) into the specified directory ready to be served. diff --git a/docs/start/install.md b/docs/start/install.md index e2115e1..bc0ca90 100644 --- a/docs/start/install.md +++ b/docs/start/install.md @@ -111,7 +111,7 @@ pip3 install invoke To display a list of the available configuration scripts, run the following command: ``` -invoke --list +inv --list ``` ## Download Source Code @@ -140,7 +140,7 @@ Now that the source code is downloaded (and optionally you have configured a Pyt To setup the InvenTree environment, run the following commands (from the InvenTree source directory): ``` -invoke install +inv install ``` This installs all required Python packages using pip package manager. It also creates a (default) database configuration file which needs to be edited to meet user needs before proceeding (see next step below). @@ -166,7 +166,7 @@ For further information on installation configuration, refer to the [Configurati Once install settings are correctly configured (in *config.yaml*) run the initial setup script: ``` -invoke migrate +inv migrate ``` This performs the initial database migrations, creating the required tables, etc. @@ -178,11 +178,11 @@ The database should now be installed! Create an initial superuser (administrator) account for the InvenTree instance: ``` -invoke superuser +inv superuser ``` !!! warning "Solving Cairo Errors" - In the case the above command returns errors with the `Cairo` package, it implies that dependencies for the `weasyprint` package are not installed on the system. To solve them, run through the [weasyprint installation steps](https://weasyprint.readthedocs.io/en/stable/install.html) then re-run `invoke install` and `invoke superuser`. + In the case the above command returns errors with the `Cairo` package, it implies that dependencies for the `weasyprint` package are not installed on the system. To solve them, run through the [weasyprint installation steps](https://weasyprint.readthedocs.io/en/stable/install.html) then re-run `inv install` and `inv superuser`. ### Run Development Server @@ -191,13 +191,13 @@ The InvenTree database is now setup and ready to run. A simple development serve To launch the development server, run the following commands: ``` -invoke server +inv server ``` For more server options, run: ``` -invoke server -h +inv server -h ``` This will launch the InvenTree web interface at `http://127.0.0.1:8000`. For other options refer to the [django docs](https://docs.djangoproject.com/en/2.2/ref/django-admin/) diff --git a/docs/start/migrate.md b/docs/start/migrate.md index 8ff3d0d..72217eb 100644 --- a/docs/start/migrate.md +++ b/docs/start/migrate.md @@ -12,14 +12,14 @@ For example, if you wish to migrate from an SQLite database backend to a MySQL d Ensure that the original database is securely backed up first! !!! info "Up to Date" - Ensure that the original database is up to date, by running `invoke migrate` + Ensure that the original database is up to date, by running `inv migrate` ### Export Data Export the database contents to a JSON file using the following command: ``` -invoke export-records -f data.json +inv export-records -f data.json ``` This will create JSON file at the specified location which contains all database records. @@ -34,7 +34,7 @@ Configure the new database using the normal processes (see [Configuration](../co Then, ensure that the database schema are correctly initialized in the new database: ``` -invoke migrate +inv migrate ``` This ensures that the required database tables exist, which must be the case before data can be imported. @@ -44,7 +44,7 @@ This ensures that the required database tables exist, which must be the case bef The new database should now be correctly initialized with the correct table structures requried to import the data. Run the following command to load the databased dump file into the new database. ``` -invoke import-records -f data.json +inv import-records -f data.json ``` !!! info "Import Filename" diff --git a/docs/start/update.md b/docs/start/update.md index c288596..032f3f6 100644 --- a/docs/start/update.md +++ b/docs/start/update.md @@ -28,7 +28,7 @@ git pull origin master Updating the database is as simple as calling the `update` script: ``` -invoke update +inv update ``` This command performs the following steps: From fd5e2952a57a7e139258f99aa046ca5ed9222bbb Mon Sep 17 00:00:00 2001 From: eeintech Date: Thu, 26 Nov 2020 13:07:21 -0500 Subject: [PATCH 2/8] Fixed JSON QR code context variable name --- docs/report/labels.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/report/labels.md b/docs/report/labels.md index 90fa71b..af74f79 100644 --- a/docs/report/labels.md +++ b/docs/report/labels.md @@ -54,5 +54,5 @@ In addition to the global label context data, the following variables are made a * quantity - *The `quantity` field of the StockItem object* * serial - *The `serial` field of the StockItem object* * uid - *The `uid` field of the StockItem object* -* qrcode - *JSON data representing the StockItem object, useful for rendering to a QR code* +* qr_data - *JSON data representing the StockItem object, useful for rendering to a QR code* * tests - *Dict object of TestResult data associated with the StockItem* \ No newline at end of file From 584c1524f1e10b9318a74ab6d0e6347386679961 Mon Sep 17 00:00:00 2001 From: eeintech Date: Mon, 30 Nov 2020 12:56:25 -0500 Subject: [PATCH 3/8] Fixed image Jinja template --- _includes/img.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/img.html b/_includes/img.html index 8547740..c690d50 100644 --- a/_includes/img.html +++ b/_includes/img.html @@ -7,7 +7,7 @@ {% if 'http' in url %} {% set doc_url = url %} {% else %} -{% set doc_url = '{{ assets }}/images/{{ url }}' %} +{% set doc_url = assets + '/images/' + url %} {% endif %}
From c4410bef8804d39140600801a16110996fe62fd3 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 16 Dec 2020 19:28:24 +1100 Subject: [PATCH 4/8] Create new structure for release information - Release information will now solely be stored here, not on GitHub --- docs/build/build.md | 7 +++ docs/new.md | 108 ++-------------------------------------- docs/releases/0.1.4.md | 109 +++++++++++++++++++++++++++++++++++++++++ docs/releases/0.1.5.md | 22 +++++++++ 4 files changed, 142 insertions(+), 104 deletions(-) create mode 100644 docs/releases/0.1.4.md create mode 100644 docs/releases/0.1.5.md diff --git a/docs/build/build.md b/docs/build/build.md index fd5a963..41da9e6 100644 --- a/docs/build/build.md +++ b/docs/build/build.md @@ -91,3 +91,10 @@ Finally, click on the "Complete Build" button to process the build completion. !!! warning "Completed Build" **A completed build cannot be re-opened**. Make sure to use the confirm only if you are certain that the build is complete. + +### Overdue Builds + +Build orders may (optionally) have a target complete date specified. If this date is reached but the build order remains incomplete, then the build is considered *overdue*. + +- Builds can be filtered by overdue status in the build list +- Overdue builds will be displayed on the home page diff --git a/docs/new.md b/docs/new.md index 43dfb5a..d6cf9aa 100644 --- a/docs/new.md +++ b/docs/new.md @@ -4,109 +4,9 @@ title: What's New ## What's New -### Release 0.1.4 +For information on the latest and greatest InvenTree features, refer to the release documentation below: -[Release 0.1.4](https://github.com/inventree/InvenTree/releases/tag/0.1.4) (November 2020) provides a number of major new features and improvements, as well as some crucial bug fixes: +| Release | Date | +| ------- | ---- | +| [0.1.4](/releases/0.1.4) | November 2020 | -#### Build Management System - -The build management system has received a major upgrade, bringing the following improvements: - -##### Partial Build Completion - -Previously, build orders had to be completed *atomically* (i.e. if the build order was to create 20x units, then all 20x units had to be created at once). - -The new build system allows the user to specify build *outputs* (of varying quantities) against a given build order. The build order cannot be completed until all build outputs are fulfilled. - -A *Build Output* is simply a StockItem object which is marked as *in production*. This stock item can be assigned a (unique) serial number which is useful for pre-allocation purposes. It also allows stock to be filtered by production status and determine how many units are being built. - -##### Stock Item Tracking - -Parts which are marked as *trackable* are now treated differently for the purpose of a build order. Stock items must be assigned against each build output (as was the case previously). When a build output is marked as complete, any *trackable* stock items which are assigned to that build output are installed *into* the build output (which is simply a StockItem). In this manner, if a *trackable* stock item is used to build another stock item, it remains tracked via the stock item it is installed into. - -Stock items which are not *trackable* are simply removed from stock when the build output is completed. - -##### Stock Allocation Improvements - -A number of UX improvements have been made to simplify the process of allocating stock items against a build output (and thus a build order). - -#### Related Parts - -Related Part denotes a relationship between two parts, when users want to show their usage is "related" to another part or simply emphasize a link between two parts. - -##### Implementation - -- New PartRelated model/table to store relationships between parts (requires migration) -- New Related tab shown in Part detail page -- Ability to add relationships between parts through both main and admin interfaces -- Can only manage relationship if user has "change" permission on Part ruleset - -##### Example View - -{% with id="related_parts_example", url="https://user-images.githubusercontent.com/4020546/96306587-8f2d0b80-0fc5-11eb-8fdb-20cb2dabfcc6.png", description="Related Parts Example View" %} -{% include 'img.html' %} -{% endwith %} - -#### InvenTree "Global" Settings - -Global settings control the default value of fields across the entire web interface, for all-users. - -!!! TODO - More information to come soon - -Also, dedicated settings sections were added for: - -- Category -- Build -- Purchase Order -- Sales Order - -For Category section, read [Category Parameter Templates](#category-parameter-templates) - -Other section allows to set the prefix of build, puchase and sales orders. - -#### Category Parameter Templates - -Added support for configuring parameter templates defined by categories. - -##### Features - -* User can now setup a list of parameter templates for each (or all) part category(ies) in InvenTree settings -* During part creation, part parameters are automatically created using the list of parameter templates from the parent category it belongs to (if option is enabled) - -##### Screenshots - -* Select category - -{% with id="related_parts_example", url="https://user-images.githubusercontent.com/4020546/98037571-c2ef9a00-1de9-11eb-96a1-542b18cdda7e.png", description="Select Category" %} -{% include 'img.html' %} -{% endwith %} - -* Add parameter template - -{% with id="related_parts_example", url="https://user-images.githubusercontent.com/4020546/98145792-1cfb6880-1e99-11eb-82eb-c96d1ba9541a.png", description="Add Parameter Template" %} -{% include 'img.html' %} -{% endwith %} - -* Control global behavior within part settings - -{% with id="related_parts_example", url="https://user-images.githubusercontent.com/4020546/98130420-39db7000-1e88-11eb-9ca0-78370e19ccdd.png", description="Global Settings For Category Templates" %} -{% include 'img.html' %} -{% endwith %} - -* Control instance behavior during part creation - -{% with id="related_parts_example", url="https://user-images.githubusercontent.com/4020546/98130496-4f509a00-1e88-11eb-9239-4dc215cbc620.png", description="Instance Settings For Category Templates" %} -{% include 'img.html' %} -{% endwith %} - - -#### Currency Support - -A more comprehensive implementation of Currency support has been implemented. - -Using the [django-money](https://github.com/django-money/django-money) library enables native support for all currency types, and the (future) possibility of offering real-time currency conversion. - -This update is "simply" an architectural change which will allow more comprehensive currency management in a future release. - -As part of the new currency library implementation, InvenTree can now track purchase price of stock items (in whichever currency the user chooses). diff --git a/docs/releases/0.1.4.md b/docs/releases/0.1.4.md new file mode 100644 index 0000000..6ab4105 --- /dev/null +++ b/docs/releases/0.1.4.md @@ -0,0 +1,109 @@ +--- +title: v0.1.4 +--- + +## Release 0.1.4 + +[Release 0.1.4](https://github.com/inventree/InvenTree/releases/tag/0.1.4) (November 2020) provides a number of major new features and improvements, as well as some crucial bug fixes: + +### Build Management System + +The build management system has received a major upgrade, bringing the following improvements: + +#### Partial Build Completion + +Previously, build orders had to be completed *atomically* (i.e. if the build order was to create 20x units, then all 20x units had to be created at once). + +The new build system allows the user to specify build *outputs* (of varying quantities) against a given build order. The build order cannot be completed until all build outputs are fulfilled. + +A *Build Output* is simply a StockItem object which is marked as *in production*. This stock item can be assigned a (unique) serial number which is useful for pre-allocation purposes. It also allows stock to be filtered by production status and determine how many units are being built. + +#### Stock Item Tracking + +Parts which are marked as *trackable* are now treated differently for the purpose of a build order. Stock items must be assigned against each build output (as was the case previously). When a build output is marked as complete, any *trackable* stock items which are assigned to that build output are installed *into* the build output (which is simply a StockItem). In this manner, if a *trackable* stock item is used to build another stock item, it remains tracked via the stock item it is installed into. + +Stock items which are not *trackable* are simply removed from stock when the build output is completed. + +#### Stock Allocation Improvements + +A number of UX improvements have been made to simplify the process of allocating stock items against a build output (and thus a build order). + +### Related Parts + +Related Part denotes a relationship between two parts, when users want to show their usage is "related" to another part or simply emphasize a link between two parts. + +#### Implementation + +- New PartRelated model/table to store relationships between parts (requires migration) +- New Related tab shown in Part detail page +- Ability to add relationships between parts through both main and admin interfaces +- Can only manage relationship if user has "change" permission on Part ruleset + +#### Example View + +{% with id="related_parts_example", url="https://user-images.githubusercontent.com/4020546/96306587-8f2d0b80-0fc5-11eb-8fdb-20cb2dabfcc6.png", description="Related Parts Example View" %} +{% include 'img.html' %} +{% endwith %} + +### InvenTree "Global" Settings + +Global settings control the default value of fields across the entire web interface, for all-users. + +!!! TODO + More information to come soon + +Also, dedicated settings sections were added for: + +- Category +- Build +- Purchase Order +- Sales Order + +For Category section, read [Category Parameter Templates](#category-parameter-templates) + +Other section allows to set the prefix of build, puchase and sales orders. + +### Category Parameter Templates + +Added support for configuring parameter templates defined by categories. + +#### Features + +* User can now setup a list of parameter templates for each (or all) part category(ies) in InvenTree settings +* During part creation, part parameters are automatically created using the list of parameter templates from the parent category it belongs to (if option is enabled) + +#### Screenshots + +* Select category + +{% with id="related_parts_example", url="https://user-images.githubusercontent.com/4020546/98037571-c2ef9a00-1de9-11eb-96a1-542b18cdda7e.png", description="Select Category" %} +{% include 'img.html' %} +{% endwith %} + +* Add parameter template + +{% with id="related_parts_example", url="https://user-images.githubusercontent.com/4020546/98145792-1cfb6880-1e99-11eb-82eb-c96d1ba9541a.png", description="Add Parameter Template" %} +{% include 'img.html' %} +{% endwith %} + +* Control global behavior within part settings + +{% with id="related_parts_example", url="https://user-images.githubusercontent.com/4020546/98130420-39db7000-1e88-11eb-9ca0-78370e19ccdd.png", description="Global Settings For Category Templates" %} +{% include 'img.html' %} +{% endwith %} + +* Control instance behavior during part creation + +{% with id="related_parts_example", url="https://user-images.githubusercontent.com/4020546/98130496-4f509a00-1e88-11eb-9239-4dc215cbc620.png", description="Instance Settings For Category Templates" %} +{% include 'img.html' %} +{% endwith %} + +### Currency Support + +A more comprehensive implementation of Currency support has been implemented. + +Using the [django-money](https://github.com/django-money/django-money) library enables native support for all currency types, and the (future) possibility of offering real-time currency conversion. + +This update is "simply" an architectural change which will allow more comprehensive currency management in a future release. + +As part of the new currency library implementation, InvenTree can now track purchase price of stock items (in whichever currency the user chooses). diff --git a/docs/releases/0.1.5.md b/docs/releases/0.1.5.md new file mode 100644 index 0000000..f994206 --- /dev/null +++ b/docs/releases/0.1.5.md @@ -0,0 +1,22 @@ +--- +title: v0.1.5 +--- + +## Release 0.1.5 + +!!! info "Development Version" + v0.1.5 is currently in development and has not yet been released + +[Release 0.1.5](https://github.com/inventree/InvenTree/releases/tag/0.1.5) (November 2020) provides a number of major new features and improvements, as well as some crucial bug fixes: + +## New Features + +### Target Date for Build Order + +[#1168](https://github.com/inventree/InvenTree/pull/1168) introduces the concept of *Target Date* for a Build Order. This is the intended completion date for the build. If the date is reached but the build is not yet complete, the build is consider *overdue*. + +## Major Bug Fixes + +| PR | Description | +| --- | --- | +| [#1144](https://github.com/inventree/InvenTree/pull/1144) | Fixes infinite loop recursion when displaying BOM table | \ No newline at end of file From fb75af519831e9e8627b01762d9443f8e3911858 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 16 Dec 2020 19:30:29 +1100 Subject: [PATCH 5/8] Add link to docs --- docs/releases/0.1.5.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/releases/0.1.5.md b/docs/releases/0.1.5.md index f994206..971b4ab 100644 --- a/docs/releases/0.1.5.md +++ b/docs/releases/0.1.5.md @@ -15,6 +15,8 @@ title: v0.1.5 [#1168](https://github.com/inventree/InvenTree/pull/1168) introduces the concept of *Target Date* for a Build Order. This is the intended completion date for the build. If the date is reached but the build is not yet complete, the build is consider *overdue*. +Refer to the [build documentation](../../build/build/#overdue-builds) for more information. + ## Major Bug Fixes | PR | Description | From 24112a35a7f8a25ed28a49a8340e9ad2bb2a64e1 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 16 Dec 2020 19:54:26 +1100 Subject: [PATCH 6/8] internal link fix --- docs/{ => releases}/new.md | 2 +- mkdocs.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename docs/{ => releases}/new.md (80%) diff --git a/docs/new.md b/docs/releases/new.md similarity index 80% rename from docs/new.md rename to docs/releases/new.md index d6cf9aa..464f39b 100644 --- a/docs/new.md +++ b/docs/releases/new.md @@ -8,5 +8,5 @@ For information on the latest and greatest InvenTree features, refer to the rele | Release | Date | | ------- | ---- | -| [0.1.4](/releases/0.1.4) | November 2020 | +| [0.1.4](../0.1.4) | November 2020 | diff --git a/mkdocs.yml b/mkdocs.yml index e0498b0..938212e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -38,7 +38,7 @@ extra_javascript: nav: - InvenTree: - About InvenTree: index.md - - What's New: new.md + - What's New: releases/new.md - Contribute: contribute.md - Getting Started: - Installation: start/install.md From 3ccf6f6e0adbe4029b33921a184722c56eb68e4b Mon Sep 17 00:00:00 2001 From: Oliver Date: Fri, 18 Dec 2020 12:03:41 +1100 Subject: [PATCH 7/8] Update 0.1.5.md Add bug description --- docs/releases/0.1.5.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/releases/0.1.5.md b/docs/releases/0.1.5.md index 971b4ab..46fd773 100644 --- a/docs/releases/0.1.5.md +++ b/docs/releases/0.1.5.md @@ -21,4 +21,5 @@ Refer to the [build documentation](../../build/build/#overdue-builds) for more i | PR | Description | | --- | --- | -| [#1144](https://github.com/inventree/InvenTree/pull/1144) | Fixes infinite loop recursion when displaying BOM table | \ No newline at end of file +| [#1144](https://github.com/inventree/InvenTree/pull/1144) | Fixes infinite loop recursion when displaying BOM table | +| [#1175](https://github.com/inventree/InvenTree/pull/1175) | Fixes display of buttons in particular StockItem tab | From 2c93c2da9ff101463aac817651cb539e9f5068f9 Mon Sep 17 00:00:00 2001 From: Oliver Date: Fri, 18 Dec 2020 20:02:18 +1100 Subject: [PATCH 8/8] Update 0.1.5.md --- docs/releases/0.1.5.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/releases/0.1.5.md b/docs/releases/0.1.5.md index 46fd773..6fd813d 100644 --- a/docs/releases/0.1.5.md +++ b/docs/releases/0.1.5.md @@ -17,6 +17,10 @@ title: v0.1.5 Refer to the [build documentation](../../build/build/#overdue-builds) for more information. +### Target Date for Sales Order + +[#1177](https://github.com/inventree/InvenTree/pull/1177) introduces the concept of *Target Date* for a Sales Order. This is the intended shipment date for the order. If the date is reached but the order is not yet complete, the order is considered *overdue*. + ## Major Bug Fixes | PR | Description |