Version number

CHANGES.md

@@ -3,7 +3,7 @@
 ## 0.8 (unreleased)
 
 
-- Nothing changed yet.
+- Made internal brostar_api version number available.
 
 
 ## 0.7 (2024-04-18)

api/views.py

@@ -15,6 +15,7 @@
 
 from api import filters, mixins, models, serializers
 from api.bro_upload import utils
+from brostar_api import __version__
 
 
 class LogoutView(views.APIView):
@@ -56,6 +57,9 @@ def get(self, request: HttpRequest, format: Any = None) -> HttpResponse:
         return Response(data)
 
 
+APIOverview.__doc__ = f"**BROstar version**: *{__version__}*"
+
+
 class LocalHostRedirectView(APIView):
     """
     View that redirects user to localhost:4200.

brostar_api/__init__.py

@@ -1,5 +1,8 @@
 # This will make sure the app is always imported when
 # Django starts so that shared_task will use this app.
+from importlib.metadata import version
+
 from .celery import app as celery_app
 
 __all__ = ("celery_app",)
+__version__ = version("brostar_api")

brostar_api/tests/test_init.py

@@ -0,0 +1,4 @@
+def test_version():
+    from brostar_api import __version__
+
+    assert __version__