Version 7 (modified by Carlton Gibson, 4 months ago) (diff)

--

Google's Summer of Code 2021

Django is a mentor organization for the 2021 Google Summer of Code. Read ​Google's page for more information on how the program works.

Django's GSoC program is being coordinated by the current Django Fellows, Carlton Gibson and Mariusz Felisiak.

Mentors

If you're interested in mentoring -- supervising a student in work on Django-related activities -- let us know via the Mentoring topic on https://forum.djangoproject.com/.

Students

Student application period opens March 29, 2021, and ends April 13, 2021.

If you'd like to get started on your proposal early, we'll be looking for a few things.

  • You'll need to have a concrete task in mind (some ideas are below) along with a solid idea of what will constitute "success" (you tell us).
  • If your proposal is a single large feature, library or site, you'll need to present a detailed design specification. This proposal should be posted to django-developers, where it can be refined until it is accepted by the developer community.
  • We'll want to know a bit about you -- links to previous work are great, if any. If you're proposing something ambitious, you'll need to convince us that you're up to the task.
  • You'll also need to provide us with a schedule, including a detailed work breakdown and major milestones so your mentor can know if and when to nag you :)

Here's an example of an accepted proposal from a previous year:

Note that none of the ideas below are good enough to be submissions in their own right (so don't copy and paste)! We'll want to know not just what you want to do but how you plan to pull it off.

Don't feel limited to the ideas below -- if you've got a cool project you want to work on, we'll probably be able to find you a mentor. We plan on approving as many projects as we possibly can.

We're accepting any GSOC proposal that fits one of the following three categories:

  • Work on Django itself - such as the ORM, forms, etc. This is what we've traditionally accepted GSoC entries in.
  • Work on tools to support Django - the dashboard (​https://dashboard.djangoproject.com/) is a good example of an existing tool that would have fit into this category.
  • Work on libraries that supplement or add new features to Django to ease development - South and Django Debug Toolbar are good examples of existing projects that would have fit here.

Unless explicitly mentioned below, we're not looking for people to work on existing third-party libraries - we aren't able to guarantee commit access to them. We may allow an exception if a maintainer of the library in question agrees to help mentor beforehand.

The broadening in scope is to allow people to work on new ideas to help Django development and developers without tying you down to having to implement it in the core codebase (and thus ruling out some projects that might otherwise be useful).

We're still going to be strict with what we accept - you'll need to provide a strong use case for your idea and show that it would be useful to a majority of developers or significantly improve the development of Django itself.

We're not looking for small groups of incremental updates - like "improve Django's Trac" - nor are we looking for impossible tasks, like "replace Trac with this brand new issue tracker I'm writing". What you propose should be a single project, achievable within the time period of GSoC, and something the core developers can help mentor you on.

We're also not looking for sites or projects that are merely written in Django - this GSoC is not for you to propose your new forum hosting site or amazing Django-based blogging engine.

Note that when you contribute code, you will be expected to adhere to the same contribution guidelines as any other code contributor. This means you will be expected to provide extensive tests and documentation for any feature you add, you will be expected to participate in discussion on ​django-developers when your topic of interest is raised. If you're not already familiar with ​Django's contribution guidelines, now would be a good time to read them - even if you're not applying to work on Django core directly, we'll still want the same level of contribution.

How can I improve my chances of being accepted?

The best thing you can do to improve your chances to be accepted as a Django GSoC student is to start contributing now. Read up on Django’s contribution documentation and make yourself known to the core team by your contributions (ideally, related to the area of your proposal). That way, when it comes time to evaluate student applications, you’ll be a known individual and more likely to be able to get the attention you need to develop a proposal.

We're looking for candidates who can demonstrate that they can engage in work of a project scope on an independent basis. We're there to help but we can't watch you every step of the way, so we need to see that motivation from you. Being active before the submissions process is the best way to demonstrate this.

Communication

All GSOC-related communication is handled via the ​Django Forum, in the Mentoring channel. Any proposals for GSOC should be submitted there, as well as discussion on the proposed projects and any updates that students post.

Please be careful to keep content to the forum clear and purposeful; if you have an idea, update, or criticism, please make sure you describe it in detail; it can be tedious asking people to clarify any vague statements.

Ideas

Here are some suggestions for projects students may want to propose (please feel free add to this list!). This isn't by any means the be-all and end-all of ideas; please feel free to submit proposals for things not on this list. Remember, we'd much prefer that you posted a draft proposal and your rough timeline / success conditions to the ​django-developers list, even if it's already on the list below; it will help you get feedback on choosing the right part of a problem, as well as helping to see if there is any interest before you start drafting a full proposal.

When developing your proposal, try to scope ideas/proposals to the 10-week timeline -- you need to be ambitious, but not too ambitious. The GSoC does not cover activities other than coding, so certain ideas ("Write a more detailed tutorial" or "Create demonstration screencasts") are not suitable for inclusion here.

On the other side, though, be sure to be concrete in your proposal. We'll want to know what your goals are, and how you plan to accomplish them.

In no particular order:

Migrations

Adapt schema editors to operate from model states instead of fake rendered models.

This is Ticket #29898.

Adding a Redis cache backend to core

The 2020 Django user survey showed Redis to be the most popular cache backend. Currently users are replying on either the django-redis or django-redis-cache packages. It would be nice to be able to offer this in core.

The task would be to implement [https://docs.djangoproject.com/en/3.1/topics/cache/#django-s-cache-framework a cache backend] for Redis, that would leave third-party packages free to expose more powerful Redis-specific functionality.

Django Benchmarking

https://github.com/django/djangobench

Django has had a benchmarking suite for a while, but we've generally got more slack at tracking the effects each commit and release has. We should institute a set of top-level benchmarks aimed at various areas (the current set in djangobench are weak in, say, the HTTP-serving-speed area) and then run them against pull requests and each release, so we can make sure Django doesn't get slower while nobody is looking.

Recent work has gone into running the benchmarks regularly and integrating the Airspeed Velocity (ASV) package. The task would be to help pick-up that work and bring the benchmarking up to the next level.

Typed Django

After a successful GSoC project working on the mypy plugin in 2020, the `django-stubs` project is open to applications for this year.

django-stubs provides type annotation stub files that enables Django code to be checked with mypy, and other type checkers. Typing is gaining ground in Python, and you can help push forward its use in the Django ecosystem.

If you're interesting in this, open a discussion on the django-stubs repo or the project chat.

Working on the Wagtail CMS

Wagtail is an open-source CMS (Content Management System) built on Django. Wagtail provides and excellent developer and editor experience. It now has over 10K stars on GitHub.

Wagtail is a friendly and welcoming part of the Django community. You can help us with a wide range of CMS features: From content editing APIs to become WCAG 2.1 Level AA compatible. We are also open to your suggestions and interests.

We're keen to increase the geographic and cultural diversity of our community. Our core team members are available to mentor you. We like to collaborate with you to make Wagtail even better.

Check out the Wagtail GSoC wiki page for detials on project ideas and how to get in touch.

Django Service Hooks

Django has a lot tied to the HTTP lifecycle, and if you run it outside of this, you miss out on some key things - like database connections being closed properly, or logging, or some middleware. The project would be to design and implement a separate way of calling Django from a service framework - even if that framework was itself HTTP based (basically, don't rely on Django having to run through WSGI/ASGI). Initial idea is to provide a context manager that replaces the wrapping of a request, but the project would have to include requirements-gathering and interviewing people who use Django to power microservices to work out what they want.

Evented Datastores

Evented, or event-sourcing, database schemas are growing in popularity - essentially, a way to implement an append-only pattern on top of a relational database, where every single event that has happened is stored, but you can still efficiently retrieve the current state of an item. Given the way the pattern works, this would be possible to implement on top of Django models - likely as a whole new Model subclass - and implement with a matching QuerySet/Model API. It would require someone very skilled in database design, and it's also arguable if it should be in Django itself, or comprise of developing a third-party app alongside adding hooks/fixes to the Django ORM where needed to make it work well.

Or Create Your Own

We have over 1000 accepted tickets on Django. Browse the issue tracker by component — here's an example filter for `contrib.staticfiles`. What's the bit of the framework that interests you? What contribution do you want to make to it?

Use the tickets as guides here. Remember the advice above, that your project needs to be both on Django itself here, and achievable in the timescale of GSoC.

Back to Top