django-polished-models

[SomeAB]

I want to start a django commons repo, but not sure if something similar already exists.

Idea:
A repo named 'django-polished-models' that contains only Django ORM models/querysets/managers that follow best practices for different common & not so common scenarios. People can contribute or improve existing models

[Stormheg]

Hey @SomeAB, to me this sounds like a good idea for both people new to Django and more experienced devs looking for reference. Though what is a best practice for one developer may not necessarily be a good one in the eyes of another. It depends who you ask, and is opinionated to some degree.

I think the word you are looking for might be 'cheatsheet', you can find many quick Django code samples from various members in the Django community if you google django orm cheatsheet. Does this roughly match what you had in mind?

Whether Django Commons is the place to host such documentation, I'll leave open to discussion.

[tim-schilling]

I second Storm's opinion. Seems like a cool idea, but things need to be a proven community need to move into Django Commons.

[bckohan]

Hi @SomeAB the typical work flow is: start the repository on your own account, once it gains traction and has a proven track record of active maintenance open a transfer issue into Django Commons. Let us know what you come up with!

[SomeAB]

Yes, thats fair & understandable. @tim-schilling @bckohan

This thread was mainly a 'preliminary check' for viability

Its motivating to know that its not entirely a bad idea on the concept level at least. Thank you all!

PS: I will keep an eye on this thread for a little while longer, then start the repo on my own. & work towards contributing to the community in this way :)

[SomeAB]

@Stormheg

1. Yes, the goal is not to attempt 'one size fits all', the goal is to collect decent enough model code examples that can be used as a reference by old & new devs alike. Not too few, nor too many variations.

2. not fixed on a name yet, but yeah django-models-cheatsheat sounds okay too.

[pedro-alvesjr]

Hey @SomeAB, I really like the idea! Having a go-to repo with solid Django model examples sounds super useful for both newbies and seasoned folks.

I get that “best practice” can be kinda subjective, so maybe it’d be cool if each example had a little note explaining when and why you’d use it. That way people get the gist and can decide what fits their project.

If you want, I’m happy to help out, like testing some models, throwing in ideas for different use cases, or helping write up simple docs to make it easy to follow.

Also, starting the repo on your own first sounds like a smart move, like some of the maintainers said. Got any models or patterns you’re thinking of kicking off with?

[SomeAB]

I'm thinking a good starting place would be user models. Because that is a common thing people change according to their needs. And yes, documentation for decision making consideration sounds like a given.

I'm doing the prep work, since I got good initial response. Would publish a public repo soon.