• Adds migrations that will be needed in Django 4 (seem to not cause any issues on <4).
• Gets rid of some Python configs from tox that aren't used.
• Update testing and manage configs to use django_extensions.db.fields.AutoSlugField (the default for a long time) and update tests accordingly.
• Update the README-listed tested versions.

Followup of #118.

Consider this a work in progress. I think it will take a few weeks to complete, but I managed to get something working early, so I can try to integrate it in the project I'm working on (named OpenWISP2 btw) before trying to merging it here.

I will also write some tests for this new use case, modeling them against the existing ones.

• [x] working rough implementation
• [x] improve naming of leading underscore classes
• [x] decide if the leading underscore classes should be kept private or made public
• [x] decide if the new abstract classes should be prefixed with Abstract (would need to modify OrgMeta)
• [x] add tests for new use case
• [x] update documentation

So far this is only halfway - I'm running into a migration error that I'm not clear as to the cause of. (The other errors I do know how to fix, mostly).

Perhaps I am misunderstanding something, but I was confused by some odd migration behavior. Steps to reproduce:

virtualenv -p python3 foo
pip install Django django-extensions django-organizations
cd $VIRTUAL_ENV; django-admin startproject foo; cd foo
# add 'organizations' to INSTALLED_APPS
python manage.py migrate
python manage.py makemigrations

Expected result (which is what happens in django-organizations 0.9.3):

No changes detected

Actual result with django-organizations 1.0.0:

Migrations for 'organizations':
/virtualenvs/foo/lib/python3.6/site-packages/organizations/migrations/0003_auto_20180111_2242.py
    - Alter field slug on organization

It's not clear to me why the above migration is being auto-generated. I thought migrations were only auto-generated when model definitions differ from existing migrations, and I would have expected any needed migrations to be included with the app.

In short, I've never seen a Django app do this before, and thus it's not clear if the above is the intended behavior.

(Looking back, it's not clear to me why existing migrations were modified in c1c88a7 — would it not have been better to create a new migration instead? cc: @AZtheAsian @nemesisdesign)

Again, perhaps I'm totally misunderstanding something. If indeed there's nothing amiss here, then I am merely seeking to be enlightened. 😇

It seems that the related_name on OrganizationUser (i.e., organization_users) which points back to Organization accomplishes the same thing, and in fact self.organization_users is used in some places in the code in place of self.users (see Organization.is_admin). Sorry, I have not gone through actually fully testing what I'm saying, as I am using Django-nonrel and ManyToManyField is not supported at all. But it does appear that using related_name on a ForeignKey is identical to using through on ManyToManyField from the other side of the relationship.

Can you eliminate ManyToManyField to make it nonrel-friendly, and in general to remove redundant fields?

Thanks!

An AttributeError is raised when signing up from an invitation:

'User' object has no attribute 'organization_set'

The exception is raised when using the default invitation backend, at this line. We're using django-organizations 0.3.0, but I reproduced it in 0.4.0 too. We're using Django 1.6.5, with Python 2.7.5.

Your implementation currently supports only multi-table model inheritance (i.e., Organization, OrganizationUser). Please support abstract model inheritance, so that models can be customized within the same table. There will likely need to be settings for: ORGANIZATION_MODEL ORGANIZATION_USER_MODEL

Hi,

As my Client class inherits from Organization, the initial migration will depen on a new created migration which is not going to be available (it was just created, locally):

Migrations for 'organizations': 0002_auto_20151112_1643.py: - Alter field created on organization - Alter field modified on organization - Alter field created on organizationowner - Alter field modified on organizationowner - Alter field created on organizationuser - Alter field modified on organizationuser

Would you mind fixing the missing migration and releasing again? this is critical for making it work correctly. Thanks!

This PR does not just fix the docs (contributing part) but also fixes (I guess so) some tips about how to create the environment to develop new features/fix bugs. To accomplish it I changed some that were raising errors like 'python setup.py test' (nosetests does not run this way). updated setup.py and requirements.txt was replaced by requirements_dev.txt. I also took advantage to fix a type where another project was referenced instead of Django-organizations.

Django 3.2 introduces DEFAULT_AUTO_FIELD . If you set this to something other than 'django.db.models.AutoField', migrations will need to be generated for django-organization's models. This pull request sets default_auto_field just for these apps so that no migrations need to be generated.

It also hides warnings on Django 3.2.

The specific warning is

RemovedInDjango41Warning: 'organizations' defines default_app_config = 'organizations.apps.OrganizationsConfig'. Django now detects this configuration automatically. You can remove default_app_config.
    app_config = AppConfig.create(entry)

Similar in another highly used django library https://github.com/pennersr/django-allauth/pull/2829

EDIT

Change allauth to django-organization

Hi,

First of all thank you for your hard work and this plugin. It's awesome. However, I'm missing some documentation about whether/how it's possible to include default view functionality you provide in my templates.

Let's say I like the default behaviour of your views -> /accounts && /accounts/1/ and I'd like to include it to my page (to a specific part of a template). Is there any easy way to do so?

NOTE: I've came back to Django after 1-2 years, so the solution might be obvious and maybe it's out of scope of this plugin's documentation, but maybe it could help if it's more explicit.

This PR adds german translations.

Additionally, I saw that some translations have their .mo files committed. I do not know if this is intentional or not, but if this is not the case, I could also delete them in this PR and add *.mo files to the .gitignore.

I'm still working my way through getting organizations implemented in my project. More a question, but I didn't see any specific way to do this - and it may be useful. I'd like to be able to have multiple "owners" or some other "admin" functionality so that the organization doesn't have to be infinitely tied to a specific user - users come and go, organizations (hopefully) persist.

Hi, I tried following the Getting Started guide, but now when I try to access the path accounts/ or invitations/ I get a 404.

When accessing the accounts/ path it also auto redirects to accounts/login which returns a 404.

I also had to change the url snippet in the guide to use the path function instead of the url one because I was getting

AttributeError: 'tuple' object has no attribute 'split_contents'

on both urls.

I'm using Django 4.0.1, DRF 3.13.1, DRF-simplejwt 5.0.0, django-extensions 3.1.5 and django-organizations 2.0.1.

I also tried disabling DRF-simplejwt in case authentication was the issue but it led to the same errors.

Thanks

Dear all,

Your thoughts on the following is highly appreciated. I get the following error message (client = organization):

<class 'clients.admin.ClientAdmin'>: (admin.E027) The value of 'prepopulated_fields' refers to 'slug', which is not an attribute of 'clients.Client'.
<class 'clients.admin.ClientUserAdmin'>: (admin.E108) The value of 'list_display[2]' refers to 'is_admin', which is not a callable, an attribute of 'ClientUserAdmin', or an attribute or method on 'clients.ClientUser'. 

This, after adding the following code to admin.py:

@admin.register(Client)
class ClientAdmin(TenantAdminMixin, BaseOrganizationAdmin):
    list_display = ('name',)

@admin.register(ClientUser)
class ClientUserAdmin(BaseOrganizationUserAdmin):
    pass

I have the following models.py:

class Client(TenantMixin, OrganizationBase):
    created_on = models.DateField(auto_now_add=True)
    auto_create_schema = True

    def __str__(self):
        return self.name

class ClientOwner(OrganizationOwnerBase):
    pass

class ClientUser(OrganizationUserBase):
    pass

class ClientUserInvitation(OrganizationInvitationBase):
    pass

I'm a bit puzzled, since I've read the following on readthedocs (cookbook section):

The base models (provided in organizations.base) instead provide only the bare minimum fields required to implement and manage organizations: if you want a slug field or timestamps on your models, you’ll need to add those in. However you can do so however you want. And if you don’t want any of those fields, you don’t have to take them.

I can of course remove the code in admin.py, but I thought first I would call in your help ;-) Any feedback is much appreciated! Best, Erwin

Using Django 3.2.7 and Python 3.9.x

Greetings!

I'm having a go at using django-organizations, and I've been getting a circular reference error when attempting to perform migrations, which I believe I can trace back to django-organizations and using a custom AUTH_USER_MODEL.

I say 'I believe' because I'm not 100% sure that I haven't done something incorrectly, but having read the documentation on using a custom user model and proxy models, I think I've covered myself...

I've included a set of steps to reproduce below which should hopefully demonstrate that either I'm doing something woefully wrong, or there's something weird going on with custom user models.

If you need any more information, or if I've stupidly broken it somehow, please let me know. :)

Thanks for your help and your time! - Vector

Steps to reproduce

1. Create and activate a virtual environment:

   python3 -m venv .venv
   source .venv/bin/activate
   

2. Install the following python requirements:

   appdirs==1.4.4
   asgiref==3.3.4
   distlib==0.3.1
   Django==3.2
   django-extensions==3.1.3
   django-organizations==2.0.0
   filelock==3.0.12
   pytz==2021.1
   six==1.15.0
   sqlparse==0.4.1
   virtualenv==20.4.2
   

3. Create a new django project (I've called mine demo) and enter the directory:

   django-admin startproject demo
   cd demo
   

4. Create an app called core which will be used for models and migrations

   python3 manage.py startapp core
   

5. Put the following content into core/models.py:

   from django.db import models
   from django.contrib.auth.models import AbstractUser
   from organizations.models import Organization
   from organizations.models import OrganizationUser
   
   class User(AbstractUser):
       created_at = models.DateTimeField(auto_now_add=True, editable=False)
       updated_at = models.DateTimeField(auto_now_add=True)
       def __str__(self):
           return self.username
   
   class Tenant(Organization):
       class Meta:
           proxy = True
   
   class TenantUser(OrganizationUser):
       class Meta:
           proxy = True
   

6. Update demo/settings.py to include the organizations and core apps, and set the custom user model:

   INSTALLED_APPS = [
       # ...
       'organizations',
       'core',
   ]
   
   AUTH_USER_MODEL = 'core.User'
   

7. Create the migrations for the project:

   python3 manage.py makemigrations
   

   At this point, I get the first bit of weird output - a migration is created against the organizations module in the virtual environment:

   Migrations for 'organizations':
     .venv/lib/python3.9/site-packages/organizations/migrations/0005_auto_20210430_0635.py
       - Alter field id on organization
       - Alter field id on organizationinvitation
       - Alter field id on organizationowner
       - Alter field id on organizationuser
   Migrations for 'core':
     core/migrations/0001_initial.py
       - Create proxy model Tenant
       - Create proxy model TenantUser
       - Create model User
   

8. Finally, attempt to create the migrations again. This time, I receive a circular reference error, which links back to the previously created migration:

   python3 manage.py makemigrations
   Traceback (most recent call last):
   [...snip...]
   django.db.migrations.exceptions.CircularDependencyError: core.0001_initial, organizations.0001_initial, organizations.0002_model_update, organizations.0003_field_fix_and_editable, organizations.0004_organizationinvitation, organizations.0005_auto_20210430_0635
   

ANSWER ON THIRD COMMENT

Hello guys,

Thanks a lot for this outstanding work.

I'm trying to integrate dj-organization into my DRF project and I'm having a bit of an issue. I'm struggling to filter the results the view sends back based on the user organization. I'm fairly new to Django and I'm having difficulties integrating it with DRF.

Here is my code.

My Organization

from django.db import models
from organizations.models import Organization

# Create your models here.

class Website(Organization):
    url = models.CharField(max_length=200)

My Model which references the org

import datetime
from django.db import models
from django.utils import timezone
from org.models import Website

class Extractor(models.Model):
   Org = models.ForeignKey(Website, related_name='extractor', on_delete=models.CASCADE)
   extractor_type = models.TextChoices('Extractor', 'HEADERS IMAGES LINKS')
   url = models.CharField(max_length=200)
   result = models.JSONField(blank=True, null=True)
   type_audit = models.CharField(blank=True, choices=extractor_type.choices, max_length=20)
   task_id = models.CharField(max_length=50, blank=True, null=True)
   status_job = models.CharField(max_length=30, blank=True, null=True)
   begin_date = models.DateTimeField(blank=True, null=True)

   def __repr__(self):
       return '<Audit {}>'.format(self.url)

And my view for the Extractor Model

Extractor view

class ExtractorViewSet(viewsets.ModelViewSet):
    permission_classes = [permissions.IsAuthenticated]
    """
    API endpoint that allows users to be viewed or edited.
    """
    queryset = Extractor.objects.order_by('-begin_date')
    serializer_class = ExtractorSerializer
    filter_backends = [DjangoFilterBackend,filters.OrderingFilter]
    filterset_fields = ['type_audit', 'status_job']
    ordering_fields = ['id', 'type_audit', 'begin_date']

My question is as follow:

Where do I filter the Extractor object based on the user in the request.user so that he only sees the extractor for his organization ?

I know this isn't an Issue as per say, but I'll be interested to add the answer in your documentation and an How To for others :)

Thanks a lot. Have a great day