You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-4Lines changed: 10 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,7 @@ The platform is in active development, parties interested in its further develop
17
17

18
18
19
19
## Motivation
20
+
20
21
Non-Performing loans pose a serious and ongoing challenge that affects many economies. Developing tools and methodologies that reduce the burden and improve the ability to manage problem loans is thus an important objective. For more background and previous work and references see the [blog post and links therein](https://www.openriskmanagement.com/opennpl-open-source-npl-platform-first-release/).
21
22
22
23
## Summary of Structure and Functionality
@@ -36,6 +37,7 @@ Once the openNPL platform is up and running:
36
37

37
38
38
39
### Machine Oriented Functionality
40
+
39
41
openNPL aims to be at the same time easy to integrate into automated (computer driven) workflows. For this reason it exposes a *REST API* that offers both overviews and granular access to individual loan records.
40
42
41
43

@@ -54,6 +56,7 @@ openNPL includes two broad categories of documentation:
54
56
particular the relevant counterparty and loan data that are important for the management of NPL portfolios
55
57
56
58
## Code and User Documentation
59
+
57
60
The technical / user documentation is included in this distribution and is hosted online at [readthedocs](http://opennpl.readthedocs.io)
58
61
59
62
## Data Documentation
@@ -66,21 +69,23 @@ The domain knowledge and detailed data documentation is provided via the **Open
66
69
The Open Risk Manual articles further connect specific NPL knowledge bases to more general *credit portfolio* and *risk management* concepts, procedures and overall knowledge bases.
67
70
68
71
# Installation
72
+
69
73
There are several options to install openNPL, check out the details below
70
74
71
75
## Manual Installation from Source
72
76
Manual installation from the repository source files requires some familiarity with python, django and web applications
73
77
74
78
### Prerequisites
75
79
- openNPL requires a working Python 3 installation (including pip)
76
-
- Python >= 3.10
77
-
- Django >= 4.0
80
+
- Python >= 3.14
81
+
- Django >= 5.2
78
82
- The precise python library dependencies are listed in the :doc:`requirements`.txt file.
79
83
- Note: The current User Interface (UI) is desktop oriented and might not work properly in smaller mobile screens
80
84
- openNPL may work with earlier versions of these packages but this has not been tested
81
-
- A linux based system is recommended. Some tweaks are required for Windows but is in principle also possible to deploy there
85
+
- A Linux based system is recommended. Some tweaks are required for Windows but is in principle also possible to deploy there
82
86
83
87
### Summary of Steps
88
+
84
89
Conceptually the required steps are as follows:
85
90
* Step 1. Clone the openNPL repository from GitHub
86
91
* Step 2. Create a virtual environment
@@ -90,7 +95,8 @@ Conceptually the required steps are as follows:
90
95
* Step 6. Load some dummy data
91
96
* Step 7. Have fun exploring openNPL!
92
97
93
-
In summary the required commands are as follows (more details in the documentation)
98
+
In summary the required commands are as follows (more details in the documentation):
Copy file name to clipboardExpand all lines: common/models.py
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Copyright (c) 2020 - 2024 Open Risk (https://www.openriskmanagement.com)
1
+
# Copyright (c) 2020 - 2025 Open Risk (https://www.openriskmanagement.com)
2
2
#
3
3
# Permission is hereby granted, free of charge, to any person obtaining a copy
4
4
# of this software and associated documentation files (the "Software"), to deal
@@ -21,7 +21,7 @@
21
21
fromdjango.dbimportmodels
22
22
23
23
'''
24
-
common abstract openNPL models
24
+
common (abstract) openNPL models
25
25
26
26
Entity
27
27
PrivatePerson
@@ -43,7 +43,7 @@
43
43
44
44
classPortfolio(models.Model):
45
45
"""
46
-
The portfolio data object is useful to aggregate datasets belonging to the same actual credit portfolio. A portfolio may be optionally named to facilitate recognition and a longer description provides further details.
46
+
The portfolio data object aggregates datasets belonging to the same actual credit portfolio. A portfolio may be optionally named to facilitate recognition. A longer description provides further details.
47
47
48
48
.. note:: The actual Portfolio data are stored in the various NPL models (with foreign key to Portfolio)
0 commit comments