Package: django-orghierarchy-turku
# django-orghierarchyReusable Django application for hierarchical organizations# Installationpip install django-orghierarchyAdddjango_orghierarchytoINSTALLED_APPSIf you wish to use your own Django model as data source model (the same way you hot-swap your own user model in Django), addDJANGO_ORGHIERARCHY_DATASOURCE_MODEL = ‘yourapp.DataSource’to your project settings. Otherwise, the barebones Django modelDataSourceat django_orghierarchy/models.py is used, it contains the fields a data source modelmustcontain to be used with django-orghierarchy. Similarly, django-orghierarchy links to your user model, soAUTH_USER_MODELmust be defined in Django project settings as always.Run migrations`python python manage.py migrate django_orghierarchy `# UsageTheOrganizationclass is the main feature of django-orghierarchy. We use [django-mptt](https://github.com/django-mptt/django-mptt/) to implement an organization hierarchy that can be as deep as you wish. Each organization has a name, a data source (referring to the system the organization data is from), origin_id (referring to organization id in the original data source), founding date and dissolution date, status (normaloraffiliated), a place in a forest of organization trees, and possibly areplacement organization, which means a link to any other organization across the trees (making the forest strictly a directed graph, not a bunch of trees). Replacement organization allows linking dissolved organization structures to new ones so that old user rights are automatically transferred across the hierarchy to the replacing organization.Each organization may haveadmin_usersandregular_users, which are linked to your Django user model. Also, an organization may havesub_organizationsandaffiliated_organizations. You may have any number of top level organizations. Also, some extra user permissions are defined, i.e.add_affiliated_organization,change_affiliated_organization,delete_affiliated_organization,replace_organizationandchange_organization_regular_users. These permissions are for addingregular usersandaffiliated organizationsin Django-admin, and creatingreplacementlinks, without being allowed to touch theadmin usersor the existing organization hierarchy.Affiliatedorganizations usually have more limited rights thannormalorganizations within the hierarchy; they are meant for external organizations you collaborate with and wish to grant limited rights to.Your desired user rights and permissions for each user group in each level of the organization depend on your application details, so you should implement your own user rights checks depending on your needs. You may e.g. create a user model permissions mixin that uses information on the user organization, as done in [Linkedevents permissions](https://github.com/City-of-Helsinki/linkedevents/blob/master/events/permissions.py) and [Linkedevents user model](https://github.com/City-of-Helsinki/linkedevents/blob/master/helevents/models.py). The user rights model is originally specified [here](https://github.com/City-of-Helsinki/linkedevents/issues/235).You may import an existing organization hierarchy from a REST API corresponding to the [6Aika Paatos decisionmaking API specification](https://github.com/6aika/api-paatos), based on the [Popolo project](http://www.popoloproject.com/), with the included importer, for example:python manage.py import_organizations “https://api.hel.fi/paatos/v1/organization/”You may give the organization data source a specific id to correspond to your own data source model ids in your project:python manage.py import_organizations “https://api.hel.fi/paatos/v1/organization/” -s original_id:imported_idOtherwise, the data source id in the original API is used for the imported organizations (helsinkiin the Helsinki API).# Development## Tests### Unit testsRun testspy.testRun tests with coverage reportpy.test –cov-report html –cov .Open htmlcov/index.html for the coverage report.### Integration testsWe need to provide different settings files for the test as the
setting variables for swappable model are only evaluated the first
time the module is imported.Run testspython manage.py test –tag=custom_ds –settings=tests.test_app.settings_custom_ds
python manage.py test –tag=custom_pk_ds –settings=tests.test_app.settings_custom_pk_ds