igs-slm 0.1.5b1__tar.gz → 0.1.5b2__tar.gz

{igs_slm-0.1.5b1 → igs_slm-0.1.5b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: igs-slm
-Version: 0.1.5b1
+Version: 0.1.5b2
 Summary: IGS Site Log Manager
 Project-URL: Homepage, https://igs-slm.readthedocs.io
 Project-URL: Documentation, https://igs-slm.readthedocs.io
@@ -64,6 +64,10 @@ Requires-Dist: python-dateutil<3.0.0,>=2.8.2
 Requires-Dist: requests<3.0.0,>=2.32.4
 Requires-Dist: rich<14.0.0,>=13.7.1
 Requires-Dist: tqdm<5.0.0,>=4.64.1
+Provides-Extra: debug
+Requires-Dist: django-debug-toolbar<5.0.0,>=4.1.0; extra == 'debug'
+Requires-Dist: django-extensions<4.0.0,>=3.1.5; extra == 'debug'
+Requires-Dist: ipdb<1.0.0,>=0.13.13; extra == 'debug'
 Provides-Extra: gunicorn
 Requires-Dist: gunicorn>=22.0.0; extra == 'gunicorn'
 Description-Content-Type: text/markdown

{igs_slm-0.1.5b1 → igs_slm-0.1.5b2}/doc/source/changelog.rst

@@ -6,13 +6,20 @@
 Change Log
 ==========
 
-v0.1.5b1 (2024-07-15)
+v0.1.5b2 (2025-07-15)
+=====================
+
+* Beta Bug Fix
+* Added `Add debug dependency group <https://github.com/International-GNSS-Service/SLM/issues/155>`_
+* Fixed `WSGI_APPLICATION default is wrong <https://github.com/International-GNSS-Service/SLM/issues/154>`_
+
+v0.1.5b1 (2025-07-15)
 =====================
 
 * Beta Bug Fix
 * Fixed `SLM_INCLUDE url inclusion is not working to spec <https://github.com/International-GNSS-Service/SLM/issues/152>`_
 
-v0.1.5b0 (2024-07-15)
+v0.1.5b0 (2025-07-15)
 =====================
 
 * Beta Increment

{igs_slm-0.1.5b1 → igs_slm-0.1.5b2}/doc/source/configuration.rst

@@ -1,5 +1,6 @@
 .. include:: refs.rst
 
+.. _configuration:
 
 =============
 Configuration
@@ -518,7 +519,7 @@ We provide a more reasonable default than Django_'s :setting:`django:DEFAULT_FRO
 -----------------------
 .. setting:: WSGI_APPLICATION
 
-Default: ``slm.wsgi``
+Default: ``slm.wsgi.application``
 
 We set a default for :setting:`django:WSGI_APPLICATION` that works if *either*:
 

{igs_slm-0.1.5b1 → igs_slm-0.1.5b2}/doc/source/index.rst

@@ -30,7 +30,8 @@ This documentation speaks to multiple audiences:
 
 * **Developers** will want to refer to the :ref:`installation`, :ref:`architecture`,
   :ref:`commands` and :ref:`reference` sections.
-* **System administrators** may be interested in :ref:`operations` and :ref:`commands`.
+* **System administrators** may be interested in :ref:`configuration`, :ref:`upgrading` and
+  :ref:`commands`.
 * **Users** and **network coordinators** will be interested in the :ref:`user_manual`.
 * **Developers** wishing to work with SLM managed data will be interested in the :ref:`api`.
 * **Everyone**, but particularly **program managers** will want to take a look at the
@@ -47,9 +48,7 @@ map is on the projects_ page.
 
 Contributions_ from the community are encouraged!
 
-.. APIs
-.. manual/index
-.. operations/index
+
 
 .. toctree::
    :maxdepth: 2
@@ -60,8 +59,10 @@ Contributions_ from the community are encouraged!
    upgrading
    configuration
    architecture/index
+   manual/index
    commands
    dependencies
+   APIs
    reference/index
    changelog
 

{igs_slm-0.1.5b1 → igs_slm-0.1.5b2}/doc/source/installation.rst

@@ -35,12 +35,19 @@ Hereafter, we will use the following terminology to describe these deployments:
 Manual Installation
 ===================
 
-The SLM is both a :doc:`Django app <django:ref/applications>` and a fully deployable website. Most
-users of the SLM will want to customize certain aspects of it (things like adding
-:pypi:`django-ldap` or :doc:`two-factor authentication <django-allauth:mfa/index>`). To facilitate
-that we will use the bundled command slm-startproject_ to generate a scaffold to build off of (not
-unlike Django's :django-admin:`startproject`). But first we must install some dependencies.
-
+The SLM is both a :doc:`Django app <django:ref/applications>` and a fully deployable website. Many
+users of the SLM will want to customize it significantly (things like adding
+:pypi:`django-ldap` or :doc:`two-factor authentication <django-allauth:mfa/index>`). It can also
+be deployed out of the box with a :ref:`minimal configuration <configuration>`. We recommend trying
+a minimal development set up first to familiarize yourself with the software and identify any data
+importing pain points. The following guide includes instructions for running the SLM out of the
+box and for generating a scaffold to customize it. We will first work through a
+:ref:`local develop <slm-startproject>` installation and then we cover
+:ref:`deployment to a production server <deploy>`.
+
+To facilitate customization we provide a bundled command slm-startproject_ to generate a scaffold to
+build off of (not unlike Django's :django-admin:`startproject`). But first we must install some
+dependencies.
 
 Dependencies
 ############
@@ -132,6 +139,8 @@ Platform specific Installation guidance.
 Start Project
 #############
 
+**If you are not customizing the SLM, skip ahead to step 2.**
+
 To get up and running quickly with your customized SLM deployment we bundle a command called
 slm-startproject_ that will scaffold out a directory structure and settings files for you to start
 working with. Before running slm-startproject_ you will need to have installed all of GeoDjango_'s
@@ -162,8 +171,8 @@ itself yet though.
 
   .. tab:: github
 
-    You also have the option of working with our development version from github, but unless you have
-    a compelling reason to do so you should use the release on pypi.
+    You also have the option of working with our development version from github, but unless you
+    have a compelling reason to do so you should use the release on pypi.
 
     .. code:: bash
 
@@ -256,16 +265,57 @@ the first question you can just hit enter to accept the defaults:
 (2) Create environment & database
 ---------------------------------
 
-* Use either psql_ or pgAdmin_ to create the database that slm-startproject_ instructs you to.
-  In our example this database would be named ``network``.
+.. tabs::
+
+  .. tab:: Basic Install
+
+    * Use either psql_ or pgAdmin_ to create a database called ``slm``.
+
+    * We recommend creating a local development :mod:`python virtual environment <venv>`, but you
+      may also use any python on your system that meets the :pypi:`igs-slm` minimum python
+      requirement.
+
+    * You will need to set a few environment variables and create an environment variable file so
+      the SLM knows some basic things about itself.
+
+    In your local development directory:
+
+    .. code-block:: bash
+
+      ?> python -m venv .venv
+      ?> source .venv/bin/activate
+      (.venv) ?> export SLM_ENV=`pwd`/.env
+      (.venv) ?> touch .env
+      (.venv) ?> pip install "igs-slm[debug]"
 
-* Use uv to install the virtual environment then activate it.
+    Add a minimal configuraton to the .env file. It may look something like this. You may also
+    refer to the :ref:`configuration` page for all of the available settings. The most important
+    settings are :setting:`SLM_ENV`, :setting:`BASE_DIR`:
 
     .. code-block:: bash
 
-      ?> uv sync --all-extras
+      DEBUG=True
+      BASE_DIR=./
+      SLM_ORG_NAME="ORG"
+      SLM_SITE_NAME="localhost"
+      # you may have to set these paths if your postgis libraries
+      # are in non-standard locations
+      # GEOS_LIBRARY_PATH=/path/to/libgeos_c.dylib
+      # GDAL_LIBRARY_PATH=/path/to/libgdal.dylib
 
 
+  .. tab:: Custom Install
+
+    * Use either psql_ or pgAdmin_ to create the database that slm-startproject_ instructs you to.
+      In our example this database would be named ``network``.
+
+    * Use uv to install the virtual environment then activate it.
+
+        .. code-block:: bash
+
+          ?> cd ./network
+          ?> uv sync --all-extras
+
 .. _import_sitelogs:
 
 (3) Import Existing Logs and Deploy
@@ -276,11 +326,23 @@ existing logs to import you'll probably just want to run :django-admin:`routine
 Otherwise gather your logs into a single directory or tar file and run the
 :django-admin:`routine install` routine:
 
-  .. code-block:: bash
+.. tabs::
+
+  .. tab:: Basic Install
+
+    .. code-block:: bash
+
+      (.venv) ?> slm routine install
 
-    ?> <slm> routine install
+  .. tab:: Custom Install
 
-**<slm> is the name of your management script. In our example it would be called 'network'.**
+    .. code-block:: bash
+
+      ?> uv run network routine install
+
+You will be prompted to create a superuser account and also for a file path or directory containing
+site logs you wish to import. After the import is finished an html log of the import process will
+open.
 
 The data import will both generate logs and record import errors and warnings as alerts and
 validation flags in the database so you can manually go through the web interface and correct any
@@ -291,24 +353,39 @@ errors.
 
 You should now be able to start up the development server and see data in your SLM instance.
 
-  .. code-block:: bash
+.. tabs::
+
+  .. tab:: Basic Install
 
-    ?> <slm> runserver
-    Performing system checks...
+    .. code-block:: bash
+
+      (.venv) ?> <slm> runserver
+      Performing system checks...
+
+      System check identified no issues (1 silenced).
+      Django version 4.2.23, using settings 'slm.settings.root'
+      Starting development server at http://127.0.0.1:8000/
+      Quit the server with CONTROL-C.
+
+  .. tab:: Custom Install
+
+    .. code-block:: bash
 
-    System check identified no issues (1 silenced).
-    Django version 4.2.14, using settings 'sites.<slm>.develop'
-    Starting development server at http://127.0.0.1:8000/
-    Quit the server with CONTROL-C.
+      ?> uv run network runserver
+      Performing system checks...
+
+      System check identified no issues (1 silenced).
+      Django version 4.2.23, using settings 'sites.network.develop'
+      Starting development server at http://127.0.0.1:8000/
+      Quit the server with CONTROL-C.
 
 In addition to the front end interface where site logs are edited, moderated and published. We use
 the `Django admin for a more direct access to system data <http://127.0.0.1:8000/admin>`_. This is
 where we control permissions and make site adjustments. You may also add users and agencies and set
 their permissions through the admin.
 
-.. tip::
 
-  Refer to :ref:`operations` for advice on production deployments.
+.. _deploy:
 
 Deploy
 ######
@@ -537,11 +614,20 @@ will migrate the database and bundle all static files:
 
   (slm_venv) ?> network routine deploy
 
+
+.. tip::
+
+  Refer to :ref:`upgrading` for advice on updating the SLM.
+
 .. _containerization:
 
 Containerization
 ================
 
+.. todo::
+
+    Instructions for running our containers..
+
 
 .. _fast_hosting:
 
@@ -549,4 +635,5 @@ Fast Hosting
 ============
 
 .. todo::
-       Instructions for quickly deploying to a hosting service..
+
+    Instructions for quickly deploying to a hosting service..

{igs_slm-0.1.5b1 → igs_slm-0.1.5b2}/doc/source/upgrading.rst

@@ -1,5 +1,6 @@
 .. include:: refs.rst
 
+.. _upgrading:
 
 =========
 Upgrading

{igs_slm-0.1.5b1 → igs_slm-0.1.5b2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "igs-slm"
-version = "0.1.5b1"
+version = "0.1.5b2"
 description = "IGS Site Log Manager"
 requires-python = ">=3.8,<4.0"
 authors = [
@@ -85,6 +85,11 @@ dependencies = [
 
 [project.optional-dependencies]
 gunicorn = ["gunicorn>=22.0.0"]
+debug = [
+    "ipdb>=0.13.13,<1.0.0",
+    "django-debug-toolbar>=4.1.0,<5.0.0",
+    "django-extensions>=3.1.5,<4.0.0",
+]
 
 
 [build-system]

{igs_slm-0.1.5b1 → igs_slm-0.1.5b2}/src/slm/__init__.py

@@ -15,7 +15,7 @@ r"""
 
 """
 
-VERSION = (0, 1, "5b1")
+VERSION = (0, 1, "5b2")
 
 __title__ = "IGS/Site Log Manager"
 __version__ = ".".join(str(i) for i in VERSION)

{igs_slm-0.1.5b1 → igs_slm-0.1.5b2}/src/slm/settings/root.py

@@ -242,5 +242,5 @@ set_default(
 )
 
 WSGI_APPLICATION = env(
-    "WSGI_APPLICATION", default=get_setting("WSGI_APPLICATION", "slm.wsgi")
+    "WSGI_APPLICATION", default=get_setting("WSGI_APPLICATION", "slm.wsgi.application")
 )

{igs_slm-0.1.5b1 → igs_slm-0.1.5b2}/uv.lock

@@ -1423,7 +1423,7 @@ wheels = [
 
 [[package]]
 name = "igs-slm"
-version = "0.1.5b1"
+version = "0.1.5b2"
 source = { editable = "." }
 dependencies = [
     { name = "chardet" },
@@ -1467,6 +1467,11 @@ dependencies = [
 ]
 
 [package.optional-dependencies]
+debug = [
+    { name = "django-debug-toolbar" },
+    { name = "django-extensions" },
+    { name = "ipdb" },
+]
 gunicorn = [
     { name = "gunicorn" },
 ]
@@ -1523,8 +1528,10 @@ requires-dist = [
     { name = "django-ckeditor", specifier = ">=6.5.1,<7.0.0" },
     { name = "django-compressor", specifier = ">=4.5.1" },
     { name = "django-crispy-forms", specifier = ">=2.0,<3.0.0" },
+    { name = "django-debug-toolbar", marker = "extra == 'debug'", specifier = ">=4.1.0,<5.0.0" },
     { name = "django-enum", specifier = ">=1.2.2,<2.0.0" },
     { name = "django-environ", specifier = ">=0.11.2" },
+    { name = "django-extensions", marker = "extra == 'debug'", specifier = ">=3.1.5,<4.0.0" },
     { name = "django-filter", specifier = ">=24.2,<25.0.0" },
     { name = "django-ipware", specifier = ">=7.0.1,<8.0.0" },
     { name = "django-polymorphic", specifier = ">=4.1.0,<5.0" },
@@ -1539,6 +1546,7 @@ requires-dist = [
     { name = "geojson", specifier = ">=3.1.0,<4.0.0" },
     { name = "gunicorn", marker = "extra == 'gunicorn'", specifier = ">=22.0.0" },
     { name = "importlib-resources", specifier = ">1.3.0" },
+    { name = "ipdb", marker = "extra == 'debug'", specifier = ">=0.13.13,<1.0.0" },
     { name = "jinja2", specifier = ">=3.1.2,<4.0.0" },
     { name = "lxml", specifier = ">=5.2.1,<6.0.0" },
     { name = "packaging", specifier = ">=24.2" },
@@ -1550,7 +1558,7 @@ requires-dist = [
     { name = "rich", specifier = ">=13.7.1,<14.0.0" },
     { name = "tqdm", specifier = ">=4.64.1,<5.0.0" },
 ]
-provides-extras = ["gunicorn"]
+provides-extras = ["gunicorn", "debug"]
 
 [package.metadata.requires-dev]
 dev = [

igs_slm-0.1.5b1/doc/source/operations/configuration.rst

@@ -1,11 +0,0 @@
-.. include:: ../refs.rst
-
-=============
-Configuration
-=============
-
-
-.. todo::
-
-    Production configuration considerations.
-

igs_slm-0.1.5b1/doc/source/operations/index.rst

@@ -1,18 +0,0 @@
-.. include:: ../refs.rst
-
-.. _operations:
-
-==========
-Operations
-==========
-
-.. todo::
-
-    Intro
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-   configuration
-   serving

igs_slm-0.1.5b1/doc/source/operations/serving.rst

@@ -1,9 +0,0 @@
-.. include:: ../refs.rst
-
-=======
-Serving
-=======
-
-.. todo::
-
-    Serving options.