Swappable Vote model

[harikvpy]

I had a requirement to add a field to Vote model and I first forked the code as a private app into my project. Then decided to try implementing the same using Django's swappable model infrastructure. This PR incorporates all the changes related to this.

The files affected might seem quite long, but they are mostly because of code re-org. models.py had to be split into base_models.py and models.py and this required touching all the files that imported models.py.

I have updated the README and the tests. The tests now cover swapped model use-case. Essentially the same tests are repeated using a swapped Vote model.

Pls review the code and if you think it's worth it, you may merge it.

[codecov]

Codecov Report

❌ Patch coverage is 86.66667% with 8 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.80%. Comparing base (89a6f59) to head (85e15b4).
⚠️ Report is 5 commits behind head on master.

Files with missing lines	Patch %	Lines
vote/utils.py	71.42%	4 Missing ⚠️
vote/models.py	70.00%	2 Missing and 1 partial ⚠️
vote/managers.py	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #85      +/-   ##
==========================================
- Coverage   92.82%   90.80%   -2.03%     
==========================================
  Files           8        9       +1     
  Lines         223      250      +27     
  Branches       23       27       +4     
==========================================
+ Hits          207      227      +20     
- Misses         13       19       +6     
- Partials        3        4       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[shellfly]

@harikvpy Hi, thanks for considering making contribution back to this repo, and I can see the swappable feature could be useful in some cases. However this change introduces a third library swapper as an extra requirement to use django-vote, this might be a noise for users who don't need this feature.

I can accept this change if you could make it an optional feature like the VoteMixin. Or if someday when the swappable model becomes an official Django feature which doesn't require a third-party library, then it'll be great to have this MR in this project.

[harikvpy]

Thanks for the quick feedback. What you raise is indeed a valid concern. It should be fairly simple to make the swappable model mechanism an optional feature. I'll have a look and revert this week.

[harikvpy]

Swapper package is optional now. The test env have been updated to cover both environments -- with swapper and without it using tox. Using tox allows testing the code against all the popular Django versions out there -- 2.2, 3.2 & 4.0, which is nice.

An unintended consequence of this is that code coverage comes down a little as the conditional import code cannot be tested in the without swapper use case.

[shellfly]

thanks for the updating, I have a few comments, PTAL

[shellfly]

This is a breaking change for users who are using this API, why do you change this?

[shellfly]

this is also a breaking change that users' code could be broken after upgrading if they use this variable.

[shellfly]

It seems there are many duplications with the current Github CI setup, could we use GitHub action to do this?