django-rql icon indicating copy to clipboard operation
django-rql copied to clipboard

Project contribution

Open diyor28 opened this issue 2 years ago • 11 comments

Hi, I use django-rql on daily basis and I would like to contribute to the project. Please let me know what I can work on

diyor28 avatar Mar 29 '22 11:03 diyor28

@diyor28 great to hear that! Just for our curiosity, would you like to share your use cases?

About contribution, thank you for the intention! Currently, we are in the process of creation of CLA for individual contributors, and I will ping you when we are done.

By the way, you can check CloudBlue vacancies here, if you are interested in contributing from the inside :)

maxipavlovic avatar Apr 01 '22 12:04 maxipavlovic

Sorry for the late reply, missed the notification. Thank you for the invitation to work at CloudBlue! Unfortunately, I'm already an Epam employee.

Regarding the use cases, I usually use it for my personal projects where I need to build a flexible API for a dashboard or admin panel with Django, Django Rest Framework, and Postgres as the backend. The way I found django-rql is quite interesting. I was working with feathersjs, Feathers-Vuex and I loved the flexiable and versatile query language that feathersjs provides, so I wanted to find a similar tool for django. And my search lead me to django-rql.

By the way, I created a typescript version of javascript-rql, since my contribution issue was ignored for some reason. You can check it out here. I would love this to be a part of javascript-rql.

Also I am building vuex-rql(npm: https://www.npmjs.com/package/vuex-rql), an API wrapper for Vuex Store. I will attach a link to npm package once I publish it

diyor28 avatar Apr 10 '22 07:04 diyor28

Thx for the explanation! Will keep in mind featherjs.

Couldn't check TS version as https://github.com/diyor28/js-rql from npm page leads to 404.

Sorry to hear about missing your issue. @borzovplus @AntonHinz please, help here https://github.com/cloudblue/javascript-rql/issues/10 :)

maxipavlovic avatar Apr 10 '22 08:04 maxipavlovic

My bad, https://github.com/diyor28/js-rql is now a valid repo.

diyor28 avatar Apr 10 '22 08:04 diyor28

Regarding django-rql for python, I noticed that it does not support querying by ForeignKey directly or it might just be that I missed it in the docs

diyor28 avatar Apr 10 '22 08:04 diyor28

You mean something like this?


class Model:
  group = FK()

class Filters:
  MODEL = Model
  FILTERS = (
    {
        'filter': 'group.id',
        'source': 'group_id',
    },

I guess, that it's a great note for index optimization purposes, which is not supported at this moment.

maxipavlovic avatar Apr 10 '22 16:04 maxipavlovic

Yeah, exactly. I believe it is a quite common use case where you might need to query records belonging to a certain user. I would love to bring support for that.

diyor28 avatar Apr 11 '22 09:04 diyor28

@diyor28 CLA is ready and integrated. Waiting for your contributions :)

maxipavlovic avatar Apr 25 '22 09:04 maxipavlovic

@maxipavlovic Happy to hear that! What part of it do you think I could start with?

diyor28 avatar Apr 25 '22 17:04 diyor28

Let's start with direct support of FKs as you proposed :)

maxipavlovic avatar Apr 26 '22 11:04 maxipavlovic

@maxipavlovic Hi, I would love to bring support for that, but I am incredibly busy right now. As soon as I get a few hours of free time I will get to work on this. Thank you for your patience.

diyor28 avatar May 14 '22 14:05 diyor28