#M05 Creating Hackathon Database Models by Ri-Dearg · Pull Request #72 · Code-Institute-Community/ci-hackathon-app

Ri-Dearg · 2020-10-16T14:53:30Z

These models are a draft that will fix issue #61
TLDR at the end.

Overview
The models.py file contains the models built from the schema here on the Development Wiki. I have followed the schema to the best of my ability. I definitely need other contributors to take a look at the fields for the Foreign Keys because I did change some of them.

I have given my reasoning for the choices in comments above each Foreign Key field. If anybody can see any errors or has a better idea of how to relate them, the advice is well appreciated! :-)

Testing
I have created each model in my own environment, it all seems grand. I deleted the DB and remigrated everything, I haven't had any errors yet. Models have a testing file that checks they can be created correctly and their str method.

To Do

Create a global method to automatically fill the created_by field on creation. Maybe find a way to prevent it from being edited.
Beautify the admin pages for the table relations and models. Some models depend on other models being present, so it can be really unintuitive to use the admin page to create them because you have to jump around.
Displaying info from the related tables and making it editable on a different model's page would make this way easier! However, I think it could be started as a new issue. The models are needed to start work on other issues and it is a job in itself.

Possible Bugs

For the HackTeam model, it uses a ManyToMany field for "participants". I thought this was useful in case a User was part of a few Hackathons. However, it means that a user could be part of more than one team for the same hackathon. I think this could be solved with a custom save method.

I know it is a long read, so thank you again for any help!

TLDR:
Please take a look at the Foreign Key fields and their comments and let me know if you see any issues. I'll fix them up and make the commits. ;-)

Created hackathon app and moved tests inside its own module.

Updating branch with base files.

Connected the "hackathon" app by urls and settings"

Foregin Key fields will be revised as other models are created.

Added to admin. Minor adjustment made to Hackathon related name field

Updated comments. Must update all FK fields.

Foreign Keys match the schema closely but need review. See comments.

Syncing with changes from upstream repo

Sitched the *-Link fields for URLFields. Added comments.

Sitched the *-Link fields for URLFields. Added comments. Added URLFields to project Model Changed *_link to URLField, added comments. This commit fixes issue #61

…to m05 Updating commits to append request to issue.

Should not be commited here.

stefdworschak

Overall a really good Pull Request. Some suggestions on how to proceed and let me know if you have any questions.

.theia/settings.json

hackathon/admin.py

hackathon/models.py

stefdworschak · 2020-10-16T15:10:58Z

hackathon/models.py

+    created_by = models.ForeignKey(User,
+                                   on_delete=models.CASCADE,
+                                   related_name="hackathon_created_by")
+    display_name = models.CharField(default="", max_length=254)


I would allow blank and null instead of defaulting to an empty string. I think that's a little bit cleaner.

I used this because the docs recommend to not do that for string-based fields here.
https://docs.djangoproject.com/en/3.1/ref/models/fields/#null

Let me know if you want me to swap it out anyway, and I'll do that. I've marked the other convos with this resolved for now tell me what you think here and I'll apply it to all of them.

Okay, just learnt something new. Did not know that, but let's follow the Django documentation then.

Actually, I was doing the same thing myself until recently, then I found this. It only has a few rules, but it's useful:
https://github.com/rocioar/flake8-django

That's really useful! Thanks for sharing.

hackathon/models.py

…to m05 Merging deletion of settings.json

Ri-Dearg

I implemented the requested changes. Main points:

I'm using default="" because Django docs recommend it for string fields. If you prefer, I'll change it.
I removed the quotes around "Hackathon" but left them for "HackProject", take a look at the comment.
I think I made that last change for the model correctly, but let me know if it's right!
Tests are incoming!

I'm also wondering should I remove the comments over FK fields before a full pull?
Thank you for all the effort ye put into supporting the project, it's a great experience for me. :-)

Ri-Dearg · 2020-10-16T18:26:42Z

hackathon/models.py

+    created_by = models.ForeignKey(User,
+                                   on_delete=models.CASCADE,
+                                   related_name="hackathon_created_by")
+    display_name = models.CharField(default="", max_length=254)


I used this because the docs recommend to not do that for string-based fields here.
https://docs.djangoproject.com/en/3.1/ref/models/fields/#null

Let me know if you want me to swap it out anyway, and I'll do that. I've marked the other convos with this resolved for now tell me what you think here and I'll apply it to all of them.

hackathon/models.py

…to m05 Consolidating an amend.

Also Changed model field name for readability.

stefdworschak · 2020-10-16T22:14:15Z

hackathon/models.py

+    # Each model can only be created by one user: One To Many
+    created_by = models.ForeignKey(User,
+                                   on_delete=models.CASCADE,
+                                   related_name="hackathon_created_by")


Sorry, I should have mentioned this in the other comment, but I would just rename all the related_names for created_by to be just the plural of the model name in lower case. I think that would be the best seeing as it they are basically a collection of that model created by a user.

Okay, makes sense, I'll do that now.

stefdworschak · 2020-10-17T10:44:43Z

Also, don't forget to fix the merge conflict.

Ri-Dearg · 2020-10-17T11:46:56Z

Okay, I changed the related names to plurals, I merged the conflict in the .gitignore adding both lines. And there are some basic str method tests in there too now.

I think it should be good to go. If you have any other corrections, let me know and I'll get right to it! :-)

…to m05 Merging with latest updates

stefdworschak

LGTM

Really good pull request! 👍

Ri-Dearg added 15 commits October 14, 2020 15:28

#P04 Started Hackathon app

e6dd2fe

Created hackathon app and moved tests inside its own module.

Merge branch 'master' into p04

ce1d431

Updating branch with base files.

Added URLs and Installed App.

cb69915

Connected the "hackathon" app by urls and settings"

Created "Hackathon" Model

4f55cc6

Foregin Key fields will be revised as other models are created.

Created Hack Award Category Model

2949910

Added to admin. Minor adjustment made to Hackathon related name field

HackTeam model created

ce56f46

Created HackProject model

5c004f0

Updated comments. Must update all FK fields.

Created HackProjectScoreModel

277d7c9

Created HackProjectScoreCategory Model

6ed572d

Added Foreign Key Fields

a2f75c1

Foreign Keys match the schema closely but need review. See comments.

Merge branch 'master' into m05

2015a80

Syncing with changes from upstream repo

Commented on ForeignKey fields

2b741b2

Added URLFields

b7376ee

Sitched the *-Link fields for URLFields. Added comments.

Added URLFields

45a288b

Sitched the *-Link fields for URLFields. Added comments. Added URLFields to project Model Changed *_link to URLField, added comments. This commit fixes issue #61

Merge branch 'm05' of https://github.com/Ri-Dearg/ci-hackathon-app in…

46064fd

…to m05 Updating commits to append request to issue.

Ri-Dearg marked this pull request as draft October 16, 2020 14:55

Delete settings.json

591169f

Should not be commited here.

stefdworschak requested changes Oct 16, 2020

View reviewed changes

Ri-Dearg added 4 commits October 16, 2020 19:11

Pull Request review changes made.

07afd39

Merge branch 'm05' of https://github.com/Ri-Dearg/ci-hackathon-app in…

f210249

…to m05 Merging deletion of settings.json

Updated gitignore to ignore settings.json

c85533b

Added last extra line on file

88c7540

Ri-Dearg commented Oct 16, 2020

View reviewed changes

Removed unecessary import and quotes.

8131a73

Ri-Dearg requested a review from stefdworschak October 16, 2020 19:36

Ri-Dearg added 5 commits October 16, 2020 19:52

Corrected Typo and added migrations.

352c80e

Updated str method on HackProjectScoreCategory to remove "score"

1195184

Updated str method on HackProjectScoreCategory to remove "score"

bdefd17

Merge branch 'm05' of https://github.com/Ri-Dearg/ci-hackathon-app in…

69603b2

…to m05 Consolidating an amend.

Test setUp method added and functional

875cc06

Also Changed model field name for readability.

Tests written for str method on models.

9cdbfcf

Ri-Dearg marked this pull request as ready for review October 16, 2020 21:35

stefdworschak reviewed Oct 16, 2020

View reviewed changes

Ri-Dearg and others added 3 commits October 17, 2020 11:37

Updated Related names in models

f09fae8

Updated .gitignore.

b1f3100

Merge branch 'master' into m05

3899109

Ri-Dearg requested a review from stefdworschak October 17, 2020 11:47

Ri-Dearg added 2 commits October 17, 2020 11:48

Added migration file.

f3ce532

Merge branch 'm05' of https://github.com/Ri-Dearg/ci-hackathon-app in…

26fa31b

…to m05 Merging with latest updates

stefdworschak approved these changes Oct 17, 2020

View reviewed changes

stefdworschak added the hacktoberfest-accepted Accepted PR during Hacktoberfest label Oct 17, 2020

stefdworschak merged commit a59f43f into Code-Institute-Community:master Oct 17, 2020

Ri-Dearg deleted the m05 branch October 17, 2020 16:20

TravelTimN linked an issue Oct 17, 2020 that may be closed by this pull request

#M05 Creating Hackathon Database Models #61

Closed

Conversation

Ri-Dearg commented Oct 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stefdworschak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stefdworschak Oct 16, 2020

Choose a reason for hiding this comment

Uh oh!

Ri-Dearg Oct 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stefdworschak Oct 16, 2020

Choose a reason for hiding this comment

Uh oh!

Ri-Dearg Oct 17, 2020

Choose a reason for hiding this comment

Uh oh!

stefdworschak Oct 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Ri-Dearg left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ri-Dearg Oct 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stefdworschak Oct 16, 2020

Choose a reason for hiding this comment

Uh oh!

Ri-Dearg Oct 17, 2020

Choose a reason for hiding this comment

Uh oh!

stefdworschak commented Oct 17, 2020

Uh oh!

Ri-Dearg commented Oct 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stefdworschak left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Ri-Dearg commented Oct 16, 2020 •

edited

Loading

Ri-Dearg Oct 16, 2020 •

edited

Loading

stefdworschak Oct 17, 2020 •

edited

Loading

Ri-Dearg left a comment •

edited

Loading

Ri-Dearg Oct 16, 2020 •

edited

Loading

Ri-Dearg commented Oct 17, 2020 •

edited

Loading