nofusscomputing/centurion_erp
1
0
Fork 0
Code Issues Wiki Activity

docs(development): update views, models and index

Browse Source 
!35
This commit is contained in:
Jon Lockwood
2024-07-14 02:53:04 +09:30
parent a7168834ba
commit d4aaea4dbb
4 changed files with 141 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

151
docs/projects/centurion_erp/development/index.md
View File

@ -15,19 +15,16 @@ This section of the documentation contains different items related to the develo
- [Forms](./api/form.md)
- [Models](./models.md)
- [Testing](./testing.md)
- [Views](./views.md)
## Random items to be relocated in the future
## Icons
_the below sections need to be refactored._
### Icons
To locate additional icons for use see [material icons](https://fonts.google.com/icons).
To locate additional icons for use see [material icons](https://fonts.google.com/icons) or [more material icons](https://pictogrammers.com/library/mdi/).
Icons with text:
@ -40,144 +37,36 @@ Icons with text:
- Issue `{% include 'icons/issue_link.html.j2' with issue=2 %}` _Used to provide a link to an issue on GitLab. i.e. incomplete feature ticket_
### Adding an Application
## Navigation
1. Install Centurion ERP application with `pip <app-name>`
Within Centurion ERP the navigation menu is dynamically built. To have an item added to the navigation bar to the left of the screen, the following items must be set:
1. Update `app.settings.py`
- within the `urlpatterns` list, the path contains the name parameter.
``` python
!!! tip
Don't use a name that starts with `_`, as this prefix is designed to be used to prevent the url from showing up within the navigation menu
INSTALLED_APPS = [
- `app_name = "<app name>"` set in `urls.py`
'<app name>.apps.<apps.py Class Name>', # Within project directory
_Example entry_
'<app name>', # not in project directory
``` py title="urls.py"
]
from django.urls import path
```
1. Update `itsm/urls.py`
``` python
urlpatterns = [
path("<url path>/", include("<app name>.urls")),
]
```
!!! tip
No url from the application will be visible without including the `name` parameter when calling the `path` function within the applications `url.py`. i.e. `urlpatterns[].path(name='<Navigation Name>')`. This is by design and when combined with a prefix of `_` provides the option to limit what URL's are displayed within the navigation menu. A name beginning with an underscore `_` will not be displayed in the menu.
Once you have completed the above list, your application will display collapsed within the navigation menu with the name of your application.
from access.views import organization
### Tenancy Setup
Within your view class include the mixin class `OrganizationPermission`, ensuring that you set the `permission_required` attribute.
app_name = "Access"
#### Model Setup
Any item you wish to be multi-tenant, ensure within your model you include the tenancy model abstract class. The class includes a field called `organization` which links directly to the organization model and is used by the tenancy permission check.
``` python title="<your app name>/models.py"
from access.models import TenancyObject
class YourObject(TenancyObject):
...
urlpatterns = [
path("", organization.IndexView.as_view(), name="Organizations"),
]
```
#### View Setup
## Tenancy Setup
The mixin inlcuded in this template `OrganizationPermission` is designed to work with all django built in views and is what does the multi-tenancy permission checks.
``` python title="<your app name>/views.py"
from django.db.models import Q
from access.mixins import OrganizationPermission
class IndexView(OrganizationPermission, generic.ListView):
model = YourModel
permission_required = 'access.view_organization'
# Use this for static success url
success_url = f"/organization/" + pk_url_kwarg
# Use this to build dynamic success URL
def get_success_url(self, **kwargs):
return f"/organization/{self.kwargs['pk']}/"
def get_queryset(self):
return MyModel.objects.filter(Q(organization__in=self.user_organizations()) | Q(is_global = True))
```
Using a filter `pk__in=self.user_organizations()` for the queryset using the mixins function `user_organizations`, will limit the query set to only items where the user is a member of the organization.
#### Templates
The base template includes blocks that are designed to assist in rendering your content. The following blocks are available:
- `title` - The page and title
- `content_header_icon` - Header icon that is middle aligned with the page title, floating right.
- `body` - The html content of the page
``` html title="template.html.j2"
{% extends 'base.html.j2' %}
{% block title %}{% endblock %}
{% block content_header_icon %}<span title="View History" id="content_header_icon">H</span>{% endblock %}
{% block body %}
your content here
{% endblock %}
```
### Add history to model
The tracking of changes can be added to a model by including the `SaveHistory` mixin from `core.mixin.history_save` to the model.
``` python
from core.mixin.history_save import SaveHistory
class MyModel(SaveHistory):
.....
```
for items that have a parent item, modification will need to be made to the mixin by adding the relevant check and setting the relevant keys.
``` python
if self._meta.model_name == 'deviceoperatingsystem':
item_parent_pk = self.device.pk
item_parent_class = self.device._meta.model_name
```
All items within Centurion ERP are considered tenancy objects. Pay particular attention to any requirement that specifies that a class is to be included. Some of these classes add the required logic for Tenancy object CRUD operations as well as permission checking.

70
docs/projects/centurion_erp/development/models.md Normal file
View File

@ -0,0 +1,70 @@
---
title: Models
description: Centurion ERP Models development documentation
date: 2024-07-14
template: project.html
about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/centurion_erp
---
Models within Centurion ERP are how the data is structured within the database. This page contains documentation pertinent to the development of the models for use with Centurion ERP.
## Requirements
All models must meet the following requirements:
- inherits from `app.access.models.TenancyObject` and `django.db.models.Model`
- class has `__str__` method defined to return that is used to return a default value if no field is specified.
- Fields are initialized with the following parameters:
- `verbose_name`
- `help_text`
## Docs to clean up
!!! note
The below documentation is still to be developed. As such what is written below may be incorrect.
## Model Setup
Any item you wish to be multi-tenant, ensure within your model you include the tenancy model abstract class. The class includes a field called `organization` which links directly to the organization model and is used by the tenancy permission check.
``` python title="<your app name>/models.py"
from access.models import TenancyObject
class YourObject(TenancyObject):
...
```
### Add history to model
The tracking of changes can be added to a model by including the `SaveHistory` mixin from `core.mixin.history_save` to the model.
``` python
from core.mixin.history_save import SaveHistory
class MyModel(SaveHistory):
.....
```
for items that have a parent item, modification will need to be made to the mixin by adding the relevant check and setting the relevant keys.
``` python
if self._meta.model_name == 'deviceoperatingsystem':
item_parent_pk = self.device.pk
item_parent_class = self.device._meta.model_name
```

50
docs/projects/centurion_erp/development/views.md
View File

@ -31,3 +31,53 @@ The views that we use are:
Display a model
Common test cases are available for views. These test cases can be found within the API docs under [model view test cases](./api/tests/model_views.md).
## Requirements
All views are to meet the following requirements:
- is defined as a class
- View class inherits from one of the above listed views
- View class has the following attributes definedL
- `form_class`
- `model`
- Add and change views to use a form class
## Docs to clean up
!!! note
The below documentation is still to be developed. As such what is written below may be incorrect.
#### Templates
The base template includes blocks that are designed to assist in rendering your content. The following blocks are available:
- `title` - The page and title
- `content_header_icon` - Header icon that is middle aligned with the page title, floating right.
- `body` - The html content of the page
``` html title="template.html.j2"
{% extends 'base.html.j2' %}
{% block title %}{% endblock %}
{% block content_header_icon %}<span title="View History" id="content_header_icon">H</span>{% endblock %}
{% block body %}
your content here
{% endblock %}
```

3
docs/projects/centurion_erp/index.md
View File

@ -120,7 +120,7 @@ Below is a list of modules/features we intend to add to Centurion. To find out w
- Virtual Machine Management _[see #73](https://gitlab.com/nofusscomputing/projects/django_template/-/issues/73)_
- Vulnerability Management
- Vulnerability Management
- Software _[see #3](https://gitlab.com/nofusscomputing/projects/django_template/-/issues/3)_
@ -144,4 +144,3 @@ Below is a list of modules/features we intend to add to Centurion. To find out w
- AWX _[see #113](https://gitlab.com/nofusscomputing/projects/django_template/-/issues/113)_
[AWX](https://github.com/ansible/awx) is an Automation Orchestration system that uses Ansible for its configuration.