/',
+ ReportSnippetDetail.as_view(),
+ name='api-report-snippet-detail',
+ ),
+ path('', ReportSnippetList.as_view(), name='api-report-snippet-list'),
+ ]),
+ ),
# Purchase order reports
path(
'po/',
@@ -528,7 +566,7 @@ report_api_urls = [
path(
'metadata/',
MetadataView.as_view(),
- {'model': PurchaseOrderReport},
+ {'model': report.models.PurchaseOrderReport},
name='api-po-report-metadata',
),
path(
@@ -558,7 +596,7 @@ report_api_urls = [
path(
'metadata/',
MetadataView.as_view(),
- {'model': SalesOrderReport},
+ {'model': report.models.SalesOrderReport},
name='api-so-report-metadata',
),
path(
@@ -586,7 +624,7 @@ report_api_urls = [
path(
'metadata/',
MetadataView.as_view(),
- {'model': ReturnOrderReport},
+ {'model': report.models.ReturnOrderReport},
name='api-so-report-metadata',
),
path(
@@ -617,7 +655,7 @@ report_api_urls = [
path(
'metadata/',
MetadataView.as_view(),
- {'model': BuildReport},
+ {'model': report.models.BuildReport},
name='api-build-report-metadata',
),
path(
@@ -645,7 +683,7 @@ report_api_urls = [
path(
'metadata/',
MetadataView.as_view(),
- {'model': BillOfMaterialsReport},
+ {'model': report.models.BillOfMaterialsReport},
name='api-bom-report-metadata',
),
path('', BOMReportDetail.as_view(), name='api-bom-report-detail'),
@@ -671,7 +709,7 @@ report_api_urls = [
path(
'metadata/',
MetadataView.as_view(),
- {'report': TestReport},
+ {'report': report.models.TestReport},
name='api-stockitem-testreport-metadata',
),
path(
@@ -705,7 +743,7 @@ report_api_urls = [
path(
'metadata/',
MetadataView.as_view(),
- {'report': StockLocationReport},
+ {'report': report.models.StockLocationReport},
name='api-stocklocation-report-metadata',
),
path(
diff --git a/InvenTree/report/models.py b/InvenTree/report/models.py
index 269b38ee6c..7958ffb08d 100644
--- a/InvenTree/report/models.py
+++ b/InvenTree/report/models.py
@@ -7,6 +7,7 @@ import sys
from django.conf import settings
from django.core.cache import cache
+from django.core.exceptions import ValidationError
from django.core.validators import FileExtensionValidator
from django.db import models
from django.template import Context, Template
@@ -585,10 +586,7 @@ class ReturnOrderReport(ReportTemplateBase):
def rename_snippet(instance, filename):
"""Function to rename a report snippet once uploaded."""
- filename = os.path.basename(filename)
-
- path = os.path.join('report', 'snippets', filename)
-
+ path = ReportSnippet.snippet_path(filename)
fullpath = settings.MEDIA_ROOT.joinpath(path).resolve()
# If the snippet file is the *same* filename as the one being uploaded,
@@ -610,6 +608,40 @@ class ReportSnippet(models.Model):
Useful for 'common' template actions, sub-templates, etc
"""
+ def __str__(self) -> str:
+ """String representation of a ReportSnippet instance."""
+ return f'snippets/{self.filename}'
+
+ @property
+ def filename(self):
+ """Return the filename of the asset."""
+ path = self.snippet.name
+ if path:
+ return os.path.basename(path)
+ else:
+ return '-'
+
+ @staticmethod
+ def snippet_path(filename):
+ """Return the fully-qualified snippet path for the given filename."""
+ return os.path.join('report', 'snippets', os.path.basename(str(filename)))
+
+ def validate_unique(self, exclude=None):
+ """Validate that this report asset is unique."""
+ proposed_path = self.snippet_path(self.snippet)
+
+ if (
+ ReportSnippet.objects.filter(snippet=proposed_path)
+ .exclude(pk=self.pk)
+ .count()
+ > 0
+ ):
+ raise ValidationError({
+ 'snippet': _('Snippet file with this name already exists')
+ })
+
+ return super().validate_unique(exclude)
+
snippet = models.FileField(
upload_to=rename_snippet,
verbose_name=_('Snippet'),
@@ -626,19 +658,20 @@ class ReportSnippet(models.Model):
def rename_asset(instance, filename):
"""Function to rename an asset file when uploaded."""
- filename = os.path.basename(filename)
-
- path = os.path.join('report', 'assets', filename)
+ path = ReportAsset.asset_path(filename)
+ fullpath = settings.MEDIA_ROOT.joinpath(path).resolve()
# If the asset file is the *same* filename as the one being uploaded,
# delete the original one from the media directory
if str(filename) == str(instance.asset):
- fullpath = settings.MEDIA_ROOT.joinpath(path).resolve()
-
if fullpath.exists():
+ # Check for existing asset file with the same name
logger.info("Deleting existing asset file: '%s'", filename)
os.remove(fullpath)
+ # Ensure the cache is deleted for this asset
+ cache.delete(fullpath)
+
return path
@@ -652,7 +685,35 @@ class ReportAsset(models.Model):
def __str__(self):
"""String representation of a ReportAsset instance."""
- return os.path.basename(self.asset.name)
+ return f'assets/{self.filename}'
+
+ @property
+ def filename(self):
+ """Return the filename of the asset."""
+ path = self.asset.name
+ if path:
+ return os.path.basename(path)
+ else:
+ return '-'
+
+ @staticmethod
+ def asset_path(filename):
+ """Return the fully-qualified asset path for the given filename."""
+ return os.path.join('report', 'assets', os.path.basename(str(filename)))
+
+ def validate_unique(self, exclude=None):
+ """Validate that this report asset is unique."""
+ proposed_path = self.asset_path(self.asset)
+
+ if (
+ ReportAsset.objects.filter(asset=proposed_path).exclude(pk=self.pk).count()
+ > 0
+ ):
+ raise ValidationError({
+ 'asset': _('Asset file with this name already exists')
+ })
+
+ return super().validate_unique(exclude)
# Asset file
asset = models.FileField(
diff --git a/InvenTree/report/serializers.py b/InvenTree/report/serializers.py
index 362aa3519e..320c489a37 100644
--- a/InvenTree/report/serializers.py
+++ b/InvenTree/report/serializers.py
@@ -1,20 +1,13 @@
"""API serializers for the reporting models."""
+from rest_framework import serializers
+
+import report.models
from InvenTree.serializers import (
InvenTreeAttachmentSerializerField,
InvenTreeModelSerializer,
)
-from .models import (
- BillOfMaterialsReport,
- BuildReport,
- PurchaseOrderReport,
- ReturnOrderReport,
- SalesOrderReport,
- StockLocationReport,
- TestReport,
-)
-
class ReportSerializerBase(InvenTreeModelSerializer):
"""Base class for report serializer."""
@@ -24,7 +17,16 @@ class ReportSerializerBase(InvenTreeModelSerializer):
@staticmethod
def report_fields():
"""Generic serializer fields for a report template."""
- return ['pk', 'name', 'description', 'template', 'filters', 'enabled']
+ return [
+ 'pk',
+ 'name',
+ 'description',
+ 'template',
+ 'filters',
+ 'page_size',
+ 'landscape',
+ 'enabled',
+ ]
class TestReportSerializer(ReportSerializerBase):
@@ -33,7 +35,7 @@ class TestReportSerializer(ReportSerializerBase):
class Meta:
"""Metaclass options."""
- model = TestReport
+ model = report.models.TestReport
fields = ReportSerializerBase.report_fields()
@@ -43,7 +45,7 @@ class BuildReportSerializer(ReportSerializerBase):
class Meta:
"""Metaclass options."""
- model = BuildReport
+ model = report.models.BuildReport
fields = ReportSerializerBase.report_fields()
@@ -53,7 +55,7 @@ class BOMReportSerializer(ReportSerializerBase):
class Meta:
"""Metaclass options."""
- model = BillOfMaterialsReport
+ model = report.models.BillOfMaterialsReport
fields = ReportSerializerBase.report_fields()
@@ -63,7 +65,7 @@ class PurchaseOrderReportSerializer(ReportSerializerBase):
class Meta:
"""Metaclass options."""
- model = PurchaseOrderReport
+ model = report.models.PurchaseOrderReport
fields = ReportSerializerBase.report_fields()
@@ -73,7 +75,7 @@ class SalesOrderReportSerializer(ReportSerializerBase):
class Meta:
"""Metaclass options."""
- model = SalesOrderReport
+ model = report.models.SalesOrderReport
fields = ReportSerializerBase.report_fields()
@@ -83,7 +85,7 @@ class ReturnOrderReportSerializer(ReportSerializerBase):
class Meta:
"""Metaclass options."""
- model = ReturnOrderReport
+ model = report.models.ReturnOrderReport
fields = ReportSerializerBase.report_fields()
@@ -93,5 +95,30 @@ class StockLocationReportSerializer(ReportSerializerBase):
class Meta:
"""Metaclass options."""
- model = StockLocationReport
+ model = report.models.StockLocationReport
fields = ReportSerializerBase.report_fields()
+
+
+class ReportSnippetSerializer(InvenTreeModelSerializer):
+ """Serializer class for the ReportSnippet model."""
+
+ class Meta:
+ """Metaclass options."""
+
+ model = report.models.ReportSnippet
+
+ fields = ['pk', 'snippet', 'description']
+
+ snippet = InvenTreeAttachmentSerializerField()
+
+
+class ReportAssetSerializer(InvenTreeModelSerializer):
+ """Serializer class for the ReportAsset model."""
+
+ class Meta:
+ """Meta class options."""
+
+ model = report.models.ReportAsset
+ fields = ['pk', 'asset', 'description']
+
+ asset = InvenTreeAttachmentSerializerField()
diff --git a/InvenTree/report/templates/report/inventree_bill_of_materials_report.html b/InvenTree/report/templates/report/inventree_bill_of_materials_report.html
index f2dd287b5b..8f34911bfc 100644
--- a/InvenTree/report/templates/report/inventree_bill_of_materials_report.html
+++ b/InvenTree/report/templates/report/inventree_bill_of_materials_report.html
@@ -11,7 +11,7 @@ margin-top: 4cm;
{% endblock page_margin %}
{% block bottom_left %}
-content: "v{{ report_revision }} - {{ date.isoformat }}";
+content: "v{{ report_revision }} - {% format_date date %}";
{% endblock bottom_left %}
{% block bottom_center %}
diff --git a/InvenTree/report/templates/report/inventree_build_order_base.html b/InvenTree/report/templates/report/inventree_build_order_base.html
index 23b76f85b2..dfb177a9fa 100644
--- a/InvenTree/report/templates/report/inventree_build_order_base.html
+++ b/InvenTree/report/templates/report/inventree_build_order_base.html
@@ -74,7 +74,7 @@ margin-top: 4cm;
{% endblock style %}
{% block bottom_left %}
-content: "v{{ report_revision }} - {{ date.isoformat }}";
+content: "v{{ report_revision }} - {% format_date date %}";
{% endblock bottom_left %}
{% block header_content %}
@@ -119,13 +119,13 @@ content: "v{{ report_revision }} - {{ date.isoformat }}";
| {% trans "Issued" %} |
- {% render_date build.creation_date %} |
+ {% format_date build.creation_date %} |
| {% trans "Target Date" %} |
{% if build.target_date %}
- {% render_date build.target_date %}
+ {% format_date build.target_date %}
{% else %}
Not specified
{% endif %}
diff --git a/InvenTree/report/templates/report/inventree_order_report_base.html b/InvenTree/report/templates/report/inventree_order_report_base.html
index ceaf3edd7e..6f936681dc 100644
--- a/InvenTree/report/templates/report/inventree_order_report_base.html
+++ b/InvenTree/report/templates/report/inventree_order_report_base.html
@@ -12,7 +12,7 @@ margin-top: 4cm;
{% endblock page_margin %}
{% block bottom_left %}
-content: "v{{ report_revision }} - {{ date.isoformat }}";
+content: "v{{ report_revision }} - {% format_date date %}";
{% endblock bottom_left %}
{% block bottom_center %}
diff --git a/InvenTree/report/templates/report/inventree_slr_report.html b/InvenTree/report/templates/report/inventree_slr_report.html
index f10c74d318..f2e13ff843 100644
--- a/InvenTree/report/templates/report/inventree_slr_report.html
+++ b/InvenTree/report/templates/report/inventree_slr_report.html
@@ -11,7 +11,7 @@ margin-top: 4cm;
{% endblock page_margin %}
{% block bottom_left %}
-content: "v{{ report_revision }} - {{ date.isoformat }}";
+content: "v{{ report_revision }} - {% format_date date %}";
{% endblock bottom_left %}
{% block bottom_center %}
diff --git a/InvenTree/report/templates/report/inventree_test_report_base.html b/InvenTree/report/templates/report/inventree_test_report_base.html
index 3afcdb474b..4e25b4598f 100644
--- a/InvenTree/report/templates/report/inventree_test_report_base.html
+++ b/InvenTree/report/templates/report/inventree_test_report_base.html
@@ -10,7 +10,7 @@
}
{% block bottom_left %}
-content: "{{ date.isoformat }}";
+content: "{% format_date date %}";
{% endblock bottom_left %}
{% block bottom_center %}
@@ -133,7 +133,7 @@ content: "{% trans 'Stock Item Test Report' %}";
{% endif %}
| {{ test_result.value }} |
{{ test_result.user.username }} |
- {{ test_result.date.date.isoformat }} |
+ {% format_date test_result.date.date %} |
{% else %}
{% if test_template.required %}
{% trans "No result (required)" %} |
diff --git a/InvenTree/report/templatetags/report.py b/InvenTree/report/templatetags/report.py
index e66cc326a9..aea2105abb 100644
--- a/InvenTree/report/templatetags/report.py
+++ b/InvenTree/report/templatetags/report.py
@@ -410,7 +410,10 @@ def format_number(number, **kwargs):
except ValueError:
pass
- value = str(number)
+ # Re-encode, and normalize again
+ value = Decimal(number).normalize()
+ value = format(value, 'f')
+ value = str(value)
leading = kwargs.get('leading', None)
@@ -422,3 +425,37 @@ def format_number(number, **kwargs):
pass
return value
+
+
+@register.simple_tag
+def format_datetime(datetime, timezone=None, format=None):
+ """Format a datetime object for display.
+
+ Arguments:
+ datetime: The datetime object to format
+ timezone: The timezone to use for the date (defaults to the server timezone)
+ format: The format string to use (defaults to ISO formatting)
+ """
+ datetime = InvenTree.helpers.to_local_time(datetime, timezone)
+
+ if format:
+ return datetime.strftime(format)
+ else:
+ return datetime.isoformat()
+
+
+@register.simple_tag
+def format_date(date, timezone=None, format=None):
+ """Format a date object for display.
+
+ Arguments:
+ date: The date to format
+ timezone: The timezone to use for the date (defaults to the server timezone)
+ format: The format string to use (defaults to ISO formatting)
+ """
+ date = InvenTree.helpers.to_local_time(date, timezone).date()
+
+ if format:
+ return date.strftime(format)
+ else:
+ return date.isoformat()
diff --git a/InvenTree/report/tests.py b/InvenTree/report/tests.py
index ab9b68f83c..2296a2f5db 100644
--- a/InvenTree/report/tests.py
+++ b/InvenTree/report/tests.py
@@ -8,10 +8,12 @@ from pathlib import Path
from django.conf import settings
from django.core.cache import cache
from django.http.response import StreamingHttpResponse
-from django.test import TestCase
+from django.test import TestCase, override_settings
from django.urls import reverse
+from django.utils import timezone
from django.utils.safestring import SafeString
+import pytz
from PIL import Image
import report.models as report_models
@@ -153,6 +155,37 @@ class ReportTagTest(TestCase):
self.assertEqual(report_tags.multiply(2.3, 4), 9.2)
self.assertEqual(report_tags.divide(100, 5), 20)
+ @override_settings(TIME_ZONE='America/New_York')
+ def test_date_tags(self):
+ """Test for date formatting tags.
+
+ - Source timezone is Australia/Sydney
+ - Server timezone is America/New York
+ """
+ time = timezone.datetime(
+ year=2024,
+ month=3,
+ day=13,
+ hour=12,
+ minute=30,
+ second=0,
+ tzinfo=pytz.timezone('Australia/Sydney'),
+ )
+
+ # Format a set of tests: timezone, format, expected
+ tests = [
+ (None, None, '2024-03-12T22:25:00-04:00'),
+ (None, '%d-%m-%y', '12-03-24'),
+ ('UTC', None, '2024-03-13T02:25:00+00:00'),
+ ('UTC', '%d-%B-%Y', '13-March-2024'),
+ ('Europe/Amsterdam', None, '2024-03-13T03:25:00+01:00'),
+ ('Europe/Amsterdam', '%y-%m-%d %H:%M', '24-03-13 03:25'),
+ ]
+
+ for tz, fmt, expected in tests:
+ result = report_tags.format_datetime(time, tz, fmt)
+ self.assertEqual(result, expected)
+
class BarcodeTagTest(TestCase):
"""Unit tests for the barcode template tags."""
diff --git a/InvenTree/stock/serializers.py b/InvenTree/stock/serializers.py
index cae8460a41..8d062f6855 100644
--- a/InvenTree/stock/serializers.py
+++ b/InvenTree/stock/serializers.py
@@ -6,7 +6,7 @@ from decimal import Decimal
from django.core.exceptions import ValidationError as DjangoValidationError
from django.db import transaction
-from django.db.models import BooleanField, Case, Count, Q, Value, When
+from django.db.models import BooleanField, Case, Count, Prefetch, Q, Value, When
from django.db.models.functions import Coalesce
from django.utils.translation import gettext_lazy as _
@@ -20,6 +20,7 @@ import company.models
import InvenTree.helpers
import InvenTree.serializers
import InvenTree.status_codes
+import part.filters as part_filters
import part.models as part_models
import stock.filters
from company.serializers import SupplierPartSerializer
@@ -289,7 +290,14 @@ class StockItemSerializer(InvenTree.serializers.InvenTreeTagModelSerializer):
'location',
'sales_order',
'purchase_order',
- 'part',
+ Prefetch(
+ 'part',
+ queryset=part_models.Part.objects.annotate(
+ category_default_location=part_filters.annotate_default_location(
+ 'category__'
+ )
+ ).prefetch_related(None),
+ ),
'part__category',
'part__pricing_data',
'supplier_part',
@@ -886,6 +894,7 @@ class LocationSerializer(InvenTree.serializers.InvenTreeTagModelSerializer):
'pathstring',
'path',
'items',
+ 'sublocations',
'owner',
'icon',
'custom_icon',
@@ -911,13 +920,18 @@ class LocationSerializer(InvenTree.serializers.InvenTreeTagModelSerializer):
def annotate_queryset(queryset):
"""Annotate extra information to the queryset."""
# Annotate the number of stock items which exist in this category (including subcategories)
- queryset = queryset.annotate(items=stock.filters.annotate_location_items())
+ queryset = queryset.annotate(
+ items=stock.filters.annotate_location_items(),
+ sublocations=stock.filters.annotate_sub_locations(),
+ )
return queryset
url = serializers.CharField(source='get_absolute_url', read_only=True)
- items = serializers.IntegerField(read_only=True)
+ items = serializers.IntegerField(read_only=True, label=_('Stock Items'))
+
+ sublocations = serializers.IntegerField(read_only=True, label=_('Sublocations'))
level = serializers.IntegerField(read_only=True)
diff --git a/InvenTree/templates/InvenTree/settings/report.html b/InvenTree/templates/InvenTree/settings/report.html
index baf57c9bfc..683625bd74 100644
--- a/InvenTree/templates/InvenTree/settings/report.html
+++ b/InvenTree/templates/InvenTree/settings/report.html
@@ -15,6 +15,7 @@
{% include "InvenTree/settings/setting.html" with key="REPORT_ENABLE" icon="fa-file-pdf" %}
{% include "InvenTree/settings/setting.html" with key="REPORT_DEFAULT_PAGE_SIZE" icon="fa-print" %}
{% include "InvenTree/settings/setting.html" with key="REPORT_DEBUG_MODE" icon="fa-laptop-code" %}
+ {% include "InvenTree/settings/setting.html" with key="REPORT_LOG_ERRORS" icon="fa-exclamation-circle" %}
{% include "InvenTree/settings/setting.html" with key="REPORT_ENABLE_TEST_REPORT" icon="fa-vial" %}
{% include "InvenTree/settings/setting.html" with key="REPORT_ATTACH_TEST_REPORT" icon="fa-file-upload" %}
diff --git a/InvenTree/templates/js/translated/bom.js b/InvenTree/templates/js/translated/bom.js
index ebf1caec67..11d03c095e 100644
--- a/InvenTree/templates/js/translated/bom.js
+++ b/InvenTree/templates/js/translated/bom.js
@@ -1172,12 +1172,18 @@ function loadBomTable(table, options={}) {
var available_stock = availableQuantity(row);
+ var external_stock = row.external_stock ?? 0;
+
var text = renderLink(`${available_stock}`, url);
if (row.sub_part_detail && row.sub_part_detail.units) {
text += ` ${row.sub_part_detail.units}`;
}
+ if (external_stock > 0) {
+ text += makeIconBadge('fa-sitemap', `{% trans "External stock" %}: ${external_stock}`);
+ }
+
if (available_stock <= 0) {
text += makeIconBadge('fa-times-circle icon-red', '{% trans "No Stock Available" %}');
} else {
diff --git a/InvenTree/templates/js/translated/build.js b/InvenTree/templates/js/translated/build.js
index 97b9ba3095..a8026414b7 100644
--- a/InvenTree/templates/js/translated/build.js
+++ b/InvenTree/templates/js/translated/build.js
@@ -2618,6 +2618,10 @@ function loadBuildLineTable(table, build_id, options={}) {
icons += makeIconBadge('fa-tools icon-blue', `{% trans "In Production" %}: ${formatDecimal(row.in_production)}`);
}
+ if (row.external_stock > 0) {
+ icons += makeIconBadge('fa-sitemap', `{% trans "External stock" %}: ${row.external_stock}`);
+ }
+
return renderLink(text, url) + icons;
}
},
@@ -2730,6 +2734,7 @@ function loadBuildLineTable(table, build_id, options={}) {
allocateStockToBuild(build_id, [row], {
output: options.output,
+ source_location: options.location,
success: function() {
$(table).bootstrapTable('refresh');
}
diff --git a/InvenTree/templates/js/translated/part.js b/InvenTree/templates/js/translated/part.js
index 240734e958..ffcea223d3 100644
--- a/InvenTree/templates/js/translated/part.js
+++ b/InvenTree/templates/js/translated/part.js
@@ -2804,6 +2804,15 @@ function loadPartCategoryTable(table, options) {
title: '{% trans "Parts" %}',
switchable: true,
sortable: true,
+ },
+ {
+ field: 'structural',
+ title: '{% trans "Structural" %}',
+ switchable: true,
+ sortable: true,
+ formatter: function(value) {
+ return yesNoLabel(value);
+ }
}
]
});
diff --git a/InvenTree/users/models.py b/InvenTree/users/models.py
index 806f39586d..701b7e8105 100644
--- a/InvenTree/users/models.py
+++ b/InvenTree/users/models.py
@@ -717,7 +717,10 @@ def check_user_role(user, role, permission):
# First, check the cache
key = f'role_{user}_{role}_{permission}'
- result = cache.get(key)
+ try:
+ result = cache.get(key)
+ except Exception:
+ result = None
if result is not None:
return result
@@ -745,7 +748,11 @@ def check_user_role(user, role, permission):
break
# Save result to cache
- cache.set(key, result, timeout=3600)
+ try:
+ cache.set(key, result, timeout=3600)
+ except Exception:
+ pass
+
return result
diff --git a/contrib/packager.io/functions.sh b/contrib/packager.io/functions.sh
index a0509a504a..97dbd71027 100755
--- a/contrib/packager.io/functions.sh
+++ b/contrib/packager.io/functions.sh
@@ -183,7 +183,7 @@ function create_initscripts() {
${INIT_CMD} stop nginx
echo "# Setting up nginx to ${SETUP_NGINX_FILE}"
# Always use the latest nginx config; important if new headers are added / needed for security
- cp ${APP_HOME}/docker/production/nginx.prod.conf ${SETUP_NGINX_FILE}
+ cp ${APP_HOME}/contrib/packager.io/nginx.prod.conf ${SETUP_NGINX_FILE}
sed -i s/inventree-server:8000/localhost:6000/g ${SETUP_NGINX_FILE}
sed -i s=var/www=opt/inventree/data=g ${SETUP_NGINX_FILE}
# Start nginx
diff --git a/contrib/packager.io/nginx.prod.conf b/contrib/packager.io/nginx.prod.conf
new file mode 100644
index 0000000000..a78b9ebd0f
--- /dev/null
+++ b/contrib/packager.io/nginx.prod.conf
@@ -0,0 +1,67 @@
+
+server {
+
+ # Listen for connection on (internal) port 80
+ # If you are exposing this server to the internet, you should use HTTPS!
+ # In which case, you should also set up a redirect from HTTP to HTTPS, and listen on port 443
+ # See the Nginx documentation for more details
+ listen 80;
+
+ real_ip_header proxy_protocol;
+
+ location / {
+
+ proxy_set_header Host $http_host;
+ proxy_set_header X-Forwarded-By $server_addr:$server_port;
+ proxy_set_header X-Forwarded-For $remote_addr;
+ proxy_set_header X-Forwarded-Proto $scheme;
+ proxy_set_header X-Real-IP $remote_addr;
+ proxy_set_header CLIENT_IP $remote_addr;
+
+ proxy_pass_request_headers on;
+
+ proxy_redirect off;
+
+ client_max_body_size 100M;
+
+ proxy_buffering off;
+ proxy_request_buffering off;
+
+ # Do not touch this unless you have a specific reason - this and the docker-compose need to match
+ proxy_pass http://inventree-server:8000;
+ }
+
+ # Redirect any requests for static files
+ location /static/ {
+ alias /var/www/static/;
+ autoindex on;
+
+ # Caching settings
+ expires 30d;
+ add_header Pragma public;
+ add_header Cache-Control "public";
+ }
+
+ # Redirect any requests for media files
+ location /media/ {
+ alias /var/www/media/;
+
+ # Media files require user authentication
+ auth_request /auth;
+
+ # Content header to force download
+ add_header Content-disposition "attachment";
+ }
+
+ # Use the 'user' API endpoint for auth
+ location /auth {
+ internal;
+
+ proxy_pass http://inventree-server:8000/auth/;
+
+ proxy_pass_request_body off;
+ proxy_set_header Content-Length "";
+ proxy_set_header X-Original-URI $request_uri;
+ }
+
+}
diff --git a/docker/.env b/docker/.env
index 39ac250ccb..447ede63b4 100644
--- a/docker/.env
+++ b/docker/.env
@@ -43,7 +43,7 @@ INVENTREE_AUTO_UPDATE=True
# Image tag that should be used
INVENTREE_TAG=stable
-# Site URL - update this to match your host (and update the Caddyfile too!)
+# Site URL - update this to match your host
INVENTREE_SITE_URL="http://inventree.localhost"
COMPOSE_PROJECT_NAME=inventree
diff --git a/docker/Caddyfile b/docker/Caddyfile
index ad7b2c26ba..8e5e2f81a7 100644
--- a/docker/Caddyfile
+++ b/docker/Caddyfile
@@ -4,33 +4,51 @@
# - INVENTREE_SERVER: The internal URL of the Inventree container (default: http://inventree-server:8000)
(log_common) {
- log {
- output file /var/log/caddy/{args.0}.access.log
- }
+ log {
+ output file /var/log/caddy/{args[0]}.access.log
+ }
+}
+
+(cors-headers) {
+ header Allow GET,HEAD,OPTIONS
+ header Access-Control-Allow-Origin *
+ header Access-Control-Allow-Methods GET,HEAD,OPTIONS
+ header Access-Control-Allow-Headers Authorization,Content-Type,User-Agent
+
+ @cors_preflight{args[0]} method OPTIONS
+
+ handle @cors_preflight{args[0]} {
+ respond "" 204
+ }
}
# Change the host to your domain (this will serve at inventree.localhost)
{$INVENTREE_SITE_URL:inventree.localhost} {
- import log_common inventree
+ import log_common inventree
- encode gzip
+ encode gzip
- request_body {
- max_size 100MB
- }
+ request_body {
+ max_size 100MB
+ }
- handle_path /static/* {
- root * /var/www/static
- file_server
- }
+ handle_path /static/* {
+ import cors-headers static
- handle_path /media/* {
- forward_auth {$INVENTREE_SERVER:"http://inventree-server:8000"} {
- uri /auth/
- }
- root * /var/www/media
- file_server
- }
+ root * /var/www/static
+ file_server
+ }
- reverse_proxy {$INVENTREE_SERVER:"http://inventree-server:8000"}
+ handle_path /media/* {
+ import cors-headers media
+
+ root * /var/www/media
+ file_server
+
+ forward_auth {$INVENTREE_SERVER:"http://inventree-server:8000"} {
+ uri /auth/
+ }
+ }
+
+ reverse_proxy {$INVENTREE_SERVER:"http://inventree-server:8000"}
}
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
index 7b948cf7ab..5fa1532481 100644
--- a/docker/docker-compose.yml
+++ b/docker/docker-compose.yml
@@ -4,7 +4,7 @@ version: "3.8"
# - PostgreSQL as the database backend
# - gunicorn as the InvenTree web server
# - django-q as the InvenTree background worker process
-# - nginx as a reverse proxy
+# - Caddy as a reverse proxy
# - redis as the cache manager (optional, disabled by default)
# ---------------------
diff --git a/docker/install_build_packages.sh b/docker/install_build_packages.sh
index ca7ea49ddf..358a256e7f 100644
--- a/docker/install_build_packages.sh
+++ b/docker/install_build_packages.sh
@@ -4,6 +4,7 @@
# Note that for postgreslql, we use the 13 version, which matches the version used in the InvenTree docker image
apk add gcc g++ musl-dev openssl-dev libffi-dev cargo python3-dev openldap-dev \
+ libstdc++ build-base linux-headers py3-grpcio \
jpeg-dev openjpeg-dev libwebp-dev zlib-dev \
sqlite sqlite-dev \
mariadb-connector-c-dev mariadb-client mariadb-dev \
diff --git a/docs/.gitignore b/docs/.gitignore
index ecbeb1b0ab..ea8649cfa3 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -10,6 +10,9 @@ env/
_build/
site/
+# Generated API schema files
+docs/api/schema/*.yml
+
# Temp files
releases.json
versions.json
diff --git a/docs/docs/api/api.md b/docs/docs/api/api.md
index 0d8b24b128..7f2c9328d0 100644
--- a/docs/docs/api/api.md
+++ b/docs/docs/api/api.md
@@ -17,6 +17,17 @@ The API is self-documenting, and the documentation is provided alongside any Inv
{% include 'img.html' %}
{% endwith %}
+### Schema Description
+ The API schema is also documented in the [API Schema](./schema.md) page.
+
+### Generating Schema File
+
+If you want to generate the API schema file yourself (for example to use with an external client, use the `invoke schema` command. Run with the `-help` command to see available options.
+
+```
+invoke schema -help
+```
+
## Authentication
Users must be authenticated to gain access to the InvenTree API. The API accepts either basic username:password authentication, or token authentication. Token authentication is recommended as it provides much faster API access.
diff --git a/docs/docs/api/schema.md b/docs/docs/api/schema.md
new file mode 100644
index 0000000000..441e977e2e
--- /dev/null
+++ b/docs/docs/api/schema.md
@@ -0,0 +1,40 @@
+---
+title: InvenTree API Schema
+---
+
+The InvenTree API is implemented using the [Django REST framework](https://www.django-rest-framework.org).
+The API schema as documented below is generated using the [drf-spectactular](https://github.com/tfranzel/drf-spectacular/) extension.
+
+## API Version
+
+This documentation is for API version: `171`
+
+!!! tip "API Schema History"
+ We track API schema changes, and provide a snapshot of each API schema version in the [API schema repository](https://github.com/inventree/schema/).
+
+## API Schema File
+
+The API schema file is available for download, and can be used for generating client libraries, or for testing API endpoints.
+
+## API Schema Documentation
+
+API schema documentation is split into the following categories:
+
+| Category | Description |
+| --- | --- |
+| [Authorization and Authentication](./schema/auth.md) | Authorization and Authentication |
+| [Background Task Management](./schema/background-task.md) | Background Task Management |
+| [Barcode Scanning](./schema/barcode.md) | Barcode Scanning |
+| [Bill of Materials](./schema/bom.md) | Bill of Materials |
+| [Build Order Management](./schema/build.md) | Build Order Management |
+| [Company Management](./schema/company.md) | Company Management |
+| [Label Printing](./schema/label.md) | Label Printing |
+| [External Machine Management](./schema/machine.md) | External Machine Management |
+| [External Order Management](./schema/order.md) | External Order Management |
+| [Parts and Part Categories](./schema/part.md) | Parts and Part Categories |
+| [Plugin Functionality](./schema/plugins.md) | Plugin Functionality |
+| [Report Generation](./schema/report.md) | Report Generation |
+| [Settings Management](./schema/settings.md) | Settings Management |
+| [Stock and Stock Locations](./schema/stock.md) | Stock and Stock Locations |
+| [User Management](./schema/user.md) | User Management |
+| [General](./schema/general.md) | General API endpoints |
diff --git a/docs/docs/api/schema/auth.md b/docs/docs/api/schema/auth.md
new file mode 100644
index 0000000000..62c8b50103
--- /dev/null
+++ b/docs/docs/api/schema/auth.md
@@ -0,0 +1,7 @@
+---
+title: Authorization and Authentication
+---
+
+The *Authorization and Authentication* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/auth.yml)]
diff --git a/docs/docs/api/schema/background-task.md b/docs/docs/api/schema/background-task.md
new file mode 100644
index 0000000000..b1d5ad0b92
--- /dev/null
+++ b/docs/docs/api/schema/background-task.md
@@ -0,0 +1,7 @@
+---
+title: Background Task Management
+---
+
+The *Background Task Management* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/background-task.yml)]
diff --git a/docs/docs/api/schema/barcode.md b/docs/docs/api/schema/barcode.md
new file mode 100644
index 0000000000..c0f5cab2bf
--- /dev/null
+++ b/docs/docs/api/schema/barcode.md
@@ -0,0 +1,7 @@
+---
+title: Barcode Scanning
+---
+
+The *Barcode Scanning* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/barcode.yml)]
diff --git a/docs/docs/api/schema/bom.md b/docs/docs/api/schema/bom.md
new file mode 100644
index 0000000000..cdfd1ff9c2
--- /dev/null
+++ b/docs/docs/api/schema/bom.md
@@ -0,0 +1,7 @@
+---
+title: Bill of Materials
+---
+
+The *Bill of Materials* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/bom.yml)]
diff --git a/docs/docs/api/schema/build.md b/docs/docs/api/schema/build.md
new file mode 100644
index 0000000000..3de0e521c6
--- /dev/null
+++ b/docs/docs/api/schema/build.md
@@ -0,0 +1,7 @@
+---
+title: Build Order Management
+---
+
+The *Build Order Management* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/build.yml)]
diff --git a/docs/docs/api/schema/company.md b/docs/docs/api/schema/company.md
new file mode 100644
index 0000000000..924d899ad4
--- /dev/null
+++ b/docs/docs/api/schema/company.md
@@ -0,0 +1,7 @@
+---
+title: Company Management
+---
+
+The *Company Management* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/company.yml)]
diff --git a/docs/docs/api/schema/general.md b/docs/docs/api/schema/general.md
new file mode 100644
index 0000000000..5da17b815d
--- /dev/null
+++ b/docs/docs/api/schema/general.md
@@ -0,0 +1,7 @@
+---
+title: General API Endpoints
+---
+
+The *General API Endpoints* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/general.yml)]
diff --git a/docs/docs/api/schema/label.md b/docs/docs/api/schema/label.md
new file mode 100644
index 0000000000..d4bc47e57c
--- /dev/null
+++ b/docs/docs/api/schema/label.md
@@ -0,0 +1,7 @@
+---
+title: Label Printing
+---
+
+The *Label Printing* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/label.yml)]
diff --git a/docs/docs/api/schema/machine.md b/docs/docs/api/schema/machine.md
new file mode 100644
index 0000000000..2fbadd41e6
--- /dev/null
+++ b/docs/docs/api/schema/machine.md
@@ -0,0 +1,7 @@
+---
+title: External Machine Management
+---
+
+The *External Machine Management* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/machine.yml)]
diff --git a/docs/docs/api/schema/order.md b/docs/docs/api/schema/order.md
new file mode 100644
index 0000000000..7f6c8fdfd7
--- /dev/null
+++ b/docs/docs/api/schema/order.md
@@ -0,0 +1,7 @@
+---
+title: External Order Management
+---
+
+The *External Order Management* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/order.yml)]
diff --git a/docs/docs/api/schema/part.md b/docs/docs/api/schema/part.md
new file mode 100644
index 0000000000..67c73eb0fb
--- /dev/null
+++ b/docs/docs/api/schema/part.md
@@ -0,0 +1,7 @@
+---
+title: Parts and Part Categories
+---
+
+The *Parts and Part Categories* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/part.yml)]
diff --git a/docs/docs/api/schema/plugins.md b/docs/docs/api/schema/plugins.md
new file mode 100644
index 0000000000..ee0263cffa
--- /dev/null
+++ b/docs/docs/api/schema/plugins.md
@@ -0,0 +1,7 @@
+---
+title: Plugin Functionality
+---
+
+The *Plugin Functionality* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/plugins.yml)]
diff --git a/docs/docs/api/schema/report.md b/docs/docs/api/schema/report.md
new file mode 100644
index 0000000000..dfad6d74be
--- /dev/null
+++ b/docs/docs/api/schema/report.md
@@ -0,0 +1,7 @@
+---
+title: Report Generation
+---
+
+The *Report Generation* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/report.yml)]
diff --git a/docs/docs/api/schema/settings.md b/docs/docs/api/schema/settings.md
new file mode 100644
index 0000000000..4a6d4f4337
--- /dev/null
+++ b/docs/docs/api/schema/settings.md
@@ -0,0 +1,7 @@
+---
+title: Settings Management
+---
+
+The *Settings Management* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/settings.yml)]
diff --git a/docs/docs/api/schema/stock.md b/docs/docs/api/schema/stock.md
new file mode 100644
index 0000000000..7b961e4b5b
--- /dev/null
+++ b/docs/docs/api/schema/stock.md
@@ -0,0 +1,7 @@
+---
+title: Stock and Stock Locations
+---
+
+The *Stock and Stock Locations* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/stock.yml)]
diff --git a/docs/docs/api/schema/user.md b/docs/docs/api/schema/user.md
new file mode 100644
index 0000000000..e0ebba2770
--- /dev/null
+++ b/docs/docs/api/schema/user.md
@@ -0,0 +1,7 @@
+---
+title: User Management
+---
+
+The *User Management* section of the InvenTree API schema is documented below.
+
+[OAD(./docs/docs/api/schema/user.yml)]
diff --git a/docs/docs/assets/images/report/template-editor.png b/docs/docs/assets/images/report/template-editor.png
new file mode 100644
index 0000000000..20b8e8bbfe
Binary files /dev/null and b/docs/docs/assets/images/report/template-editor.png differ
diff --git a/docs/docs/assets/images/report/template-table.png b/docs/docs/assets/images/report/template-table.png
new file mode 100644
index 0000000000..36ec1164fd
Binary files /dev/null and b/docs/docs/assets/images/report/template-table.png differ
diff --git a/docs/docs/concepts/units.md b/docs/docs/concepts/units.md
index d65d122bc5..7b26ae445f 100644
--- a/docs/docs/concepts/units.md
+++ b/docs/docs/concepts/units.md
@@ -34,6 +34,15 @@ Scientific notation is also supported, and can be used to represent very large o
!!! tip "Case Sensitive"
Support for scientific notation is case sensitive. For example, `1E3` is a valid value, but `1e3` is not.
+### Feet and Inches
+
+Shorthand notation is supported for feet and inches. For example, the following values would all be considered *valid*:
+
+- `3'`: `3 feet`
+- `6"` : `6 inches`
+
+However, note that compound measurements (e.g. `3'6"`) are not supported.
+
### Case Sensitivity
The pint library is case sensitive, and units must be specified in the correct case. For example, `kg` is a valid unit, but `KG` is not. In particular, you need to pay close attention when using SI prefixes (e.g. `k` for kilo, `M` for mega, `n` for nano, etc).
@@ -48,7 +57,7 @@ The [unit of measure](../part/part.md#units-of-measure) field for the [Part](../
### Supplier Part
-The [supplier part](../part/part/#supplier-parts) model uses real-world units to convert between supplier part quantities and internal stock quantities. Unit conversion rules ensure that only compatible unit types can be supplied
+The [supplier part](../part/part.md/#supplier-parts) model uses real-world units to convert between supplier part quantities and internal stock quantities. Unit conversion rules ensure that only compatible unit types can be supplied
### Part Parameter
diff --git a/docs/docs/extend/plugins/tags.md b/docs/docs/extend/plugins/tags.md
index ebcfdc3502..c7853e0baa 100644
--- a/docs/docs/extend/plugins/tags.md
+++ b/docs/docs/extend/plugins/tags.md
@@ -8,7 +8,7 @@ Several models in InvenTree can be tagged with arbitrary tags. Tags are useful f
Tags are shared between all models that can be tagged.
The following models can be tagged:
-- [Parts](../../part/part.md) and [Supplier Parts](../../order/company#supplier-parts)/[Manufacturer Part](../../order/company#manufacturer-parts)
+- [Parts](../../part/part.md) and [Supplier Parts](../../order/company.md#supplier-parts)/[Manufacturer Part](../../order/company.md#manufacturer-parts)
- [Stock Items](../../stock/stock.md#stock-item) / [Stock Location](../../stock/stock.md#stock-location)
diff --git a/docs/docs/part/create.md b/docs/docs/part/create.md
index 0eab451789..46750fbd67 100644
--- a/docs/docs/part/create.md
+++ b/docs/docs/part/create.md
@@ -64,6 +64,6 @@ If the *Add Supplier Data* option is checked, then supplier part and manufacture
The following alternative methods for creating parts are supported:
-- [Via the REST API](../../api/api)
-- [Using the Python library](../../api/python)
-- [Within the Admin interface](../../settings/admin)
+- [Via the REST API](../api/api.md)
+- [Using the Python library](../api/python/python.md)
+- [Within the Admin interface](../settings/admin.md)
diff --git a/docs/docs/part/notification.md b/docs/docs/part/notification.md
index 48d0bffde9..27aed5a9cd 100644
--- a/docs/docs/part/notification.md
+++ b/docs/docs/part/notification.md
@@ -7,7 +7,7 @@ title: Part Notifications
Users can select to receive notifications when certain events occur.
!!! warning "Email Configuration Required"
- External notifications require correct [email configuration](../../start/config/#email-settings). They also need to be enabled in the settings under notifications`.
+ External notifications require correct [email configuration](../start/config.md#email-settings). They also need to be enabled in the settings under notifications`.
!!! warning "Valid Email Address"
Each user must have a valid email address associated with their account to receive email notifications
@@ -50,7 +50,7 @@ Any users who are subscribed to notifications for the part in question will rece
### Build Order Notification
-When a new [Build Order](../../build/build/) is created, the InvenTree software checks to see if any of the parts required to complete the order are low on stock.
+When a new [Build Order](../build/build.md) is created, the InvenTree software checks to see if any of the parts required to complete the order are low on stock.
If there are any parts with low stock, a notification is generated for any users subscribed to notifications for the part being built.
diff --git a/docs/docs/part/trackable.md b/docs/docs/part/trackable.md
index 55aba96f89..4810c0a94c 100644
--- a/docs/docs/part/trackable.md
+++ b/docs/docs/part/trackable.md
@@ -2,7 +2,7 @@
title: Trackable Parts
---
-Denoting a part as *Trackble* changes the way that [stock items](../../stock/stock) associated with the particular part are handled in the database. A trackable part also has more restrictions imposed by the database scheme.
+Denoting a part as *Trackble* changes the way that [stock items](../stock/stock.md) associated with the particular part are handled in the database. A trackable part also has more restrictions imposed by the database scheme.
## Stock Tracking
diff --git a/docs/docs/releases/0.1.5.md b/docs/docs/releases/0.1.5.md
index 593c68cc39..1199a8e317 100644
--- a/docs/docs/releases/0.1.5.md
+++ b/docs/docs/releases/0.1.5.md
@@ -24,7 +24,7 @@ Refer to the [build documentation](../build/build.md#overdue-builds) for more in
### Stock Item Expiry
-[#1202](https://github.com/inventree/InvenTree/pull/1202) introduces the concept of an *Expiry Date* for Stock Items. For further information, refer to the [expiry documentation](../../stock/expiry).
+[#1202](https://github.com/inventree/InvenTree/pull/1202) introduces the concept of an *Expiry Date* for Stock Items. For further information, refer to the [expiry documentation](../stock/expiry.md).
### Stock Ownership
diff --git a/docs/docs/releases/0.2.1.md b/docs/docs/releases/0.2.1.md
index 036e03ec7b..c992bd7db6 100644
--- a/docs/docs/releases/0.2.1.md
+++ b/docs/docs/releases/0.2.1.md
@@ -14,7 +14,7 @@ title: Release 0.2.1
!!! warning "Configuration Required"
Refer to the [email configuration
- options](../../start/config/#email-settings).
+ options](../start/config.md#email-settings).
### Manufacturer Parts
diff --git a/docs/docs/releases/0.6.0.md b/docs/docs/releases/0.6.0.md
index 90a0971499..5edd0d2d97 100644
--- a/docs/docs/releases/0.6.0.md
+++ b/docs/docs/releases/0.6.0.md
@@ -54,7 +54,7 @@ PR [#2119](https://github.com/inventree/InvenTree/pull/2119) adds the ability to
### SSO Support
-PR [#2017](https://github.com/inventree/InvenTree/pull/2017) adds support for SSO (single sign on) authentication. SSO integration requires configuration by the system administrator. Refer to the [SSO documentation](../settings/sso) for further information.
+PR [#2017](https://github.com/inventree/InvenTree/pull/2017) adds support for SSO (single sign on) authentication. SSO integration requires configuration by the system administrator. Refer to the [SSO documentation](../settings/SSO.md) for further information.
### BOM Substitution
@@ -74,7 +74,7 @@ PR [#2208](https://github.com/inventree/InvenTree/pull/2208) provides notificati
### MFA Support
-PR [#2221](https://github.com/inventree/InvenTree/pull/2221) adds support for MFA (multi factor authentication). This enables admins to require all users to enable MFA as a second auth step. Refer to the [documentation](../settings/mfa) for further information.
+PR [#2221](https://github.com/inventree/InvenTree/pull/2221) adds support for MFA (multi factor authentication). This enables admins to require all users to enable MFA as a second auth step. Refer to the [documentation](../settings/MFA.md) for further information.
### Stock Item Forms
PR [#2198](https://github.com/inventree/InvenTree/pull/2198) provides a major refactor of stock item forms, for creating and editing stock items. These forms have been migrated to the REST API, providing a much more responsive user experience.
diff --git a/docs/docs/report/bom.md b/docs/docs/report/bom.md
index f6f2864e01..13de616082 100644
--- a/docs/docs/report/bom.md
+++ b/docs/docs/report/bom.md
@@ -40,7 +40,7 @@ margin-top: 4cm;
{% endblock %}
{% block bottom_left %}
-content: "v{{report_revision}} - {{ date.isoformat }}";
+content: "v{{report_revision}} - {% format_date date %}";
{% endblock %}
{% block bottom_center %}
diff --git a/docs/docs/report/build.md b/docs/docs/report/build.md
index f1b138f5eb..ab6b740d7e 100644
--- a/docs/docs/report/build.md
+++ b/docs/docs/report/build.md
@@ -186,7 +186,7 @@ margin-top: 4cm;
{% endblock %}
{% block bottom_left %}
-content: "v{{report_revision}} - {{ date.isoformat }}";
+content: "v{{report_revision}} - {% format_date date %}";
{% endblock %}
{% block header_content %}
@@ -230,13 +230,13 @@ content: "v{{report_revision}} - {{ date.isoformat }}";
| {% trans "Issued" %} |
- {% render_date build.creation_date %} |
+ {% format_date build.creation_date %} |
| {% trans "Target Date" %} |
{% if build.target_date %}
- {% render_date build.target_date %}
+ {% format_date build.target_date %}
{% else %}
Not specified
{% endif %}
diff --git a/docs/docs/report/helpers.md b/docs/docs/report/helpers.md
index 6aa5475e23..b275ede4b9 100644
--- a/docs/docs/report/helpers.md
+++ b/docs/docs/report/helpers.md
@@ -64,7 +64,7 @@ To return an element corresponding to a certain key in a container which support
{% endraw %}
```
-## Formatting Numbers
+## Number Formatting
The helper function `format_number` allows for some common number formatting options. It takes a number (or a number-like string) as an input, as well as some formatting arguments. It returns a *string* containing the formatted number:
@@ -78,7 +78,33 @@ The helper function `format_number` allows for some common number formatting opt
{% endraw %}
```
-## Rendering Currency
+## Date Formatting
+
+For rendering date and datetime information, the following helper functions are available:
+
+- `format_date`: Format a date object
+- `format_datetime`: Format a datetime object
+
+Each of these helper functions takes a date or datetime object as an input, and returns a *string* containing the formatted date or datetime. The following additional arguments are available:
+
+| Argument | Description |
+| --- | --- |
+| timezone | Specify the timezone to render the date in. If not specified, uses the InvenTree server timezone |
+| format | Specify the format string to use for rendering the date. If not specified, uses ISO formatting. Refer to the [datetime format codes](https://docs.python.org/3/library/datetime.html#format-codes) for more information! |
+
+### Example
+
+A simple example of using the date formatting helper functions:
+
+```html
+{% raw %}
+{% load report %}
+Date: {% format_date my_date timezone="Australia/Sydney" %}
+Datetime: {% format_datetime my_datetime format="%d-%m-%Y %H:%M%S" %}
+{% endraw %}
+```
+
+## Currency Formatting
The helper function `render_currency` allows for simple rendering of currency data. This function can also convert the specified amount of currency into a different target currency:
diff --git a/docs/docs/report/report.md b/docs/docs/report/report.md
index e82ac5ead6..1bd05c3c6d 100644
--- a/docs/docs/report/report.md
+++ b/docs/docs/report/report.md
@@ -117,6 +117,7 @@ So, if you are writing a template which has custom formatting, (or any other sec
```html
{% raw %}
+{% load l10n %}
|