🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Add `Settings.semantic_responses` flag (#589)
Users might not need our semantic responses at all. It needs a kill switch.
We need to add
If set to
Probably, we should add
This would need several tests:
1. Snapshot test for the resulting OpenAPI spec
2. Test that response validation would still be required, missing responses must raise
Also, this would require docs in
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Add `Settings.semantic_responses` flag (#589)
Users might not need our semantic responses at all. It needs a kill switch.
We need to add
Settings.semantic_responses flag, which should be True by default.If set to
False, we should not add any extra response specs to the final metadata.Probably, we should add
if check for this in EndpointMetadata.response_spec_providersThis would need several tests:
1. Snapshot test for the resulting OpenAPI spec
2. Test that response validation would still be required, missing responses must raise
419Also, this would require docs in
configuration.rst#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
❤1
Исправить одну строчку в новом релизе, чтобы исправить гонку.
https://github.com/reagento/dishka/issues/686
https://github.com/reagento/dishka/issues/686
GitHub
Possible race condition in compilation · Issue #686 · reagento/dishka
In version 1.9 new cache key generation introduced in factory compilation as a unique object. Because of this, compilation is no more idempotent. This should be replaced with CompilationKey See: ht...
😱2👍1
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Add 3 more tests for component schema generation (#603)
There are several cases that we don't cover in
1. We need to test
django-modern-rest/tests/test_unit/test_openapi/test_schema_snapshots.py
Line 66 in 8555cd5
2. We need to test
django-modern-rest/tests/test_unit/test_openapi/test_schema_snapshots.py
Line 67 in 8555cd5
These corner cases can just be added to the existing
1. We also need to test at least one file field as a list, add one field to
django-modern-rest/tests/test_unit/test_openapi/test_schema_snapshots.py
Line 122 in 8555cd5
This can be added to
This is a super easy issue for first-timers only :)
#enhancement #good_first_issue #help_wanted #python #django_modern_rest
sent via relator
📝 Add 3 more tests for component schema generation (#603)
There are several cases that we don't cover in
tests/test_unit/test_openapi/test_schema_snapshots.py1. We need to test
Query component schema generation with one field in __dmr_force_list__ and one other regular fielddjango-modern-rest/tests/test_unit/test_openapi/test_schema_snapshots.py
Line 66 in 8555cd5
2. We need to test
Query component with at least one field indjango-modern-rest/tests/test_unit/test_openapi/test_schema_snapshots.py
Line 67 in 8555cd5
These corner cases can just be added to the existing
_QueryModel1. We also need to test at least one file field as a list, add one field to
__dmr_force_list__ for FileMetadata component as welldjango-modern-rest/tests/test_unit/test_openapi/test_schema_snapshots.py
Line 122 in 8555cd5
This can be added to
_SeveralFiles model.This is a super easy issue for first-timers only :)
#enhancement #good_first_issue #help_wanted #python #django_modern_rest
sent via relator
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Make an `@overload`ed function from `load_schema` (#625)
Currently
Otherwise it needs extra params:
django-modern-rest/dmr/openapi/mappers/schema_loader.py
Lines 21 to 28 in 6c06cd9
This needs to be an overload.
This is a very easy task :)
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Make an `@overload`ed function from `load_schema` (#625)
Currently
load_schema can accept just a single argument if should_generate_examples is False.Otherwise it needs extra params:
django-modern-rest/dmr/openapi/mappers/schema_loader.py
Lines 21 to 28 in 6c06cd9
This needs to be an overload.
This is a very easy task :)
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Support django's `i18n` for translation (#426)
All our user-facing texts must use django's i18n.
We will only provide en-us translation for now. Later more can be added if needed.
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Support django's `i18n` for translation (#426)
All our user-facing texts must use django's i18n.
We will only provide en-us translation for now. Later more can be added if needed.
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Formalize our CDN / static files support for OpenAPI renderers (#678)
I think that we should be able to configure: do we want to use local static files, served by django for OpenAPI renderers and interactive APIs, or should we use CDN for this.
Currently:
• Swagger uses local static files
• Scalar / Redoc use CDNs
Plan:
1. Introduce
2. Only when some lib has this explicit setting, we should use the CDN. Otherwise, they should use local static files which should be copied to
3. We need to document the EXACT versions we have bundleded in our static files
4. We need to copy their licenses as well, not just static files. Because we take their code / build result. They can go to our
#enhancement #good_first_issue #help_wanted #openapi #django_modern_rest
sent via relator
📝 Formalize our CDN / static files support for OpenAPI renderers (#678)
I think that we should be able to configure: do we want to use local static files, served by django for OpenAPI renderers and interactive APIs, or should we use CDN for this.
Currently:
• Swagger uses local static files
• Scalar / Redoc use CDNs
Plan:
1. Introduce
openapi_static_cdn: {'scalar': 'https://cdn_url.com'} option, where we can specify when these libs should use CDN2. Only when some lib has this explicit setting, we should use the CDN. Otherwise, they should use local static files which should be copied to
dmr3. We need to document the EXACT versions we have bundleded in our static files
4. We need to copy their licenses as well, not just static files. Because we take their code / build result. They can go to our
LICENSE.md at the very bottom, specify why it is there#enhancement #good_first_issue #help_wanted #openapi #django_modern_rest
sent via relator
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Make an `@overload` from `SchemaGenerator.__call__` (#679)
This code right now is not ideal:
django-modern-rest/dmr/openapi/generators/schema.py
Lines 22 to 31 in 8917dd3
Because when
While it is
This needs to be an
This is a very easy task for first-timers only :)
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Make an `@overload` from `SchemaGenerator.__call__` (#679)
This code right now is not ideal:
django-modern-rest/dmr/openapi/generators/schema.py
Lines 22 to 31 in 8917dd3
Because when
skip_registration=True, we know that we return a Schema object only.While it is
skip_registration=False we can return Schema | Reference.This needs to be an
@overloaded function with correct return types.This is a very easy task for first-timers only :)
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
🚀 New issue to wemake-services/wemake-python-styleguide by @sobolevn
📝 Add `llms.txt` and `llms-full.txt` (#3619)
Let's add
It will generate
Plugin: https://github.com/wemake-services/django-modern-rest/blob/048bfa4e19f897a6ca9fbae63af14df56882b991/docs/conf.py#L72
Configuration: https://github.com/wemake-services/django-modern-rest/blob/048bfa4e19f897a6ca9fbae63af14df56882b991/docs/conf.py#L256-L258
#help_wanted #levelstarter #documentation #good_first_issue #wemake_python_styleguide #wps
sent via relator
📝 Add `llms.txt` and `llms-full.txt` (#3619)
Let's add
sphinx_llms_txt extension for the WPS: https://sphinx-llms-txt.readthedocs.io/en/latest/It will generate
llms.txt and llms-full.txtPlugin: https://github.com/wemake-services/django-modern-rest/blob/048bfa4e19f897a6ca9fbae63af14df56882b991/docs/conf.py#L72
Configuration: https://github.com/wemake-services/django-modern-rest/blob/048bfa4e19f897a6ca9fbae63af14df56882b991/docs/conf.py#L256-L258
#help_wanted #levelstarter #documentation #good_first_issue #wemake_python_styleguide #wps
sent via relator
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Integrate property-based `schemathesis` tests for routes that require `jwt` auth (#687)
We use
But, right now it does not not have any information about how it can get our JWT token to test protected APIs. This is a downside of our setup.
So, what should we do?
1. We should add a dynamic auth class for the jwt auth: https://schemathesis.readthedocs.io/en/stable/guides/auth/#dynamic-token-authentication
2. Next, modify all controllers' bodies in https://github.com/wemake-services/django-modern-rest/blob/master/django_test_app/server/apps/jwt_auth/views.py to raise an error
3. Test that
4. Revert
This is going to be interesing!
Refs schemathesis/schemathesis#3620
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Integrate property-based `schemathesis` tests for routes that require `jwt` auth (#687)
We use
schemathesis to run property-based tests on our API: https://github.com/wemake-services/django-modern-rest/blob/master/tests/test_integration/test_openapi/test_schema.pyBut, right now it does not not have any information about how it can get our JWT token to test protected APIs. This is a downside of our setup.
So, what should we do?
1. We should add a dynamic auth class for the jwt auth: https://schemathesis.readthedocs.io/en/stable/guides/auth/#dynamic-token-authentication
2. Next, modify all controllers' bodies in https://github.com/wemake-services/django-modern-rest/blob/master/django_test_app/server/apps/jwt_auth/views.py to raise an error
3. Test that
schemathsis can successfully log in and find these failure4. Revert
views.py changes and ensure that now all tests passThis is going to be interesing!
Refs schemathesis/schemathesis#3620
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
❤1
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Deploy example application somewhere (#691)
We have an example Django app that we can deploy somewhere: https://github.com/wemake-services/django-modern-rest/tree/master/django_test_app
So, users would have a real life application to test and interact with.
I propose finding a service that:
• Is free for our case
• Can support deployments from GitHub Actions, so we can do that in CI as well
• Provides some kind of a permanent link, so we can share it
• Does not require complex deployment strategy
Like PythonAnywhere or Heroku or Vercel, etc.
Any help is appreciated.
#documentation #enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Deploy example application somewhere (#691)
We have an example Django app that we can deploy somewhere: https://github.com/wemake-services/django-modern-rest/tree/master/django_test_app
So, users would have a real life application to test and interact with.
I propose finding a service that:
• Is free for our case
• Can support deployments from GitHub Actions, so we can do that in CI as well
• Provides some kind of a permanent link, so we can share it
• Does not require complex deployment strategy
Like PythonAnywhere or Heroku or Vercel, etc.
Any help is appreciated.
#documentation #enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Translate `django-modenr-rest` to your native language! (#718)
Docs: https://docs.djangoproject.com/en/6.0/topics/i18n/
How to do it?
1. Run
2. Run
3. Translate the new file created in
4. Run
5. Done! You are awesome, submit the PR :)
We welcome all contributions!
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Translate `django-modenr-rest` to your native language! (#718)
Docs: https://docs.djangoproject.com/en/6.0/topics/i18n/
How to do it?
1. Run
poetry install --all-groups --all-extras2. Run
poetry run django-admin makemessages -l YOUR_LOCALE, for example: poetry run django-admin makemessages -l ru_RU, full list of locales: https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes3. Translate the new file created in
dmr/locale/YOUR_LOCALE/LC_MESSAGES/django.po4. Run
poetry run django-admin compilemessages5. Done! You are awesome, submit the PR :)
We welcome all contributions!
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
Находки в опенсорсе: Python
🚀 New issue to wemake-services/django-modern-rest by @sobolevn 📝 Translate `django-modenr-rest` to your native language! (#718) Docs: https://docs.djangoproject.com/en/6.0/topics/i18n/ How to do it? 1. Run poetry install --all-groups --all-extras 2. Run…
задача очень большая, языков много! подключайтесь :)
Находки в опенсорсе: Python pinned «🚀 New issue to wemake-services/django-modern-rest by @sobolevn 📝 Translate `django-modenr-rest` to your native language! (#718) Docs: https://docs.djangoproject.com/en/6.0/topics/i18n/ How to do it? 1. Run poetry install --all-groups --all-extras 2. Run…»
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Support `openapi.yaml` (#745)
Litestar supports
It should be only available if
Everything else should be identical to
This is a rather easy task, so new contributors are very welcome!
#documentation #good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Support `openapi.yaml` (#745)
Litestar supports
openapi.yaml view, so should we: https://docs.litestar.dev/latest/usage/openapi/ui_plugins.htmlIt should be only available if
msgspec is installed, it can dump yaml with msgspec.yaml.Everything else should be identical to
openapi.json view.This is a rather easy task, so new contributors are very welcome!
#documentation #good_first_issue #help_wanted #django_modern_rest
sent via relator
🔥1
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Test `Controller[BaseSerializer]` corner case (#749)
Currently we don't test that
It must accept subclasses for
We need:
• a test case here https://github.com/wemake-services/django-modern-rest/blob/master/tests/test_unit/test_controllers/test_extend_controller.py
• a possible fix to raise an error when
django-modern-rest/dmr/controller.py
Lines 157 to 164 in acb9c17
This is a very easy task, so new contributors are very welcome!
#bug #good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Test `Controller[BaseSerializer]` corner case (#749)
Currently we don't test that
Controller[BaseSerializer] is not a valid way of creating a controller class.It must accept subclasses for
BaseSerializer, but not BaseSerializer itself.We need:
• a test case here https://github.com/wemake-services/django-modern-rest/blob/master/tests/test_unit/test_controllers/test_extend_controller.py
• a possible fix to raise an error when
BaseSerializer is given to a controller here:django-modern-rest/dmr/controller.py
Lines 157 to 164 in acb9c17
This is a very easy task, so new contributors are very welcome!
#bug #good_first_issue #help_wanted #django_modern_rest
sent via relator
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Support `Path` with `*args` (#754)
Right now
However, parsing from
django-modern-rest/dmr/components.py
Lines 655 to 662 in b3f9c08
What should we do instead?
1. When
1. We would return
2. Test this with unnamed
3. Test this in
4. Document this feature in
5. Provide an example in
6. Provide a changelog entry
7. Remove
Contributions are welcome! This is an intermediate level task :)
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Support `Path` with `*args` (#754)
Right now
Path component only supports parsing from request.kwargs. Which is like 99% of cases.However, parsing from
request.args is not supported:django-modern-rest/dmr/components.py
Lines 655 to 662 in b3f9c08
What should we do instead?
1. When
request.args is provided we should require models like:>>> import pydantic
>>> class UserId(pydantic.BaseModel):
... user_id: int
>>> PathModel = pydantic.RootModel[tuple[tuple[int, ...], UserId]]
>>> PathModel.model_validate((('1', '2', '3'), {'user_id': 10}))
RootModel[tuple[tuple[int, ...], UserId]](root=((1, 2, 3), UserId(user_id=10)))
1. We would return
tuple[Args, Kwargs] from this component if request.args is set2. Test this with unnamed
re_path urls https://docs.djangoproject.com/en/6.0/topics/http/urls/#using-unnamed-regular-expression-groups3. Test this in
tests/test_unit/test_components/test_path.py4. Document this feature in
docs/pages/components/path.rst5. Provide an example in
docs/examples/components/path_args.py and include it to path.rst6. Provide a changelog entry
7. Remove
_UNNAMED_PATH_PARAMS_MSG and all translations of this string, recompile all translations with make translationsContributions are welcome! This is an intermediate level task :)
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Use the latest django version by default (#759)
Currently we use
django-modern-rest/pyproject.toml
Line 77 in bea5f2d
But, we need to use the latest one. Which is
Also, we would need to change this CI job to use
django-modern-rest/.github/workflows/test.yml
Lines 71 to 78 in bea5f2d
#good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Use the latest django version by default (#759)
Currently we use
5.2 by default:django-modern-rest/pyproject.toml
Line 77 in bea5f2d
But, we need to use the latest one. Which is
6.0.Also, we would need to change this CI job to use
5.2 instead:django-modern-rest/.github/workflows/test.yml
Lines 71 to 78 in bea5f2d
#good_first_issue #help_wanted #django_modern_rest
sent via relator
❤1
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Provide our own `settings` fixture (#760)
When using
However, we have
So, let's add a new fixture to
Also, remove all
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Provide our own `settings` fixture (#760)
When using
settings fixture from pytest-django we frequently change them.However, we have
dmr_clean_settings fixture, which should be use when we touch our own settings.So, let's add a new fixture to
dmr_pytest.py which will return unchanged settings: LazySettings, but will also use dmr_clean_settings.Also, remove all
dmr_clean_settings from our own tests, where settings is used.#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Provide `dmr.cookies.set_cookies` helper function (#773)
Currently we have two places where we duplicate this code:
django-modern-rest/dmr/streaming/controller.py
Lines 172 to 178 in a6bc356
and
django-modern-rest/dmr/response.py
Lines 256 to 259 in a6bc356
So, it can probably be useful to others as well.
Let's move this to
Also, document it in
This is a very easy task for new contributors.
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator
📝 Provide `dmr.cookies.set_cookies` helper function (#773)
Currently we have two places where we duplicate this code:
django-modern-rest/dmr/streaming/controller.py
Lines 172 to 178 in a6bc356
and
django-modern-rest/dmr/response.py
Lines 256 to 259 in a6bc356
So, it can probably be useful to others as well.
Let's move this to
cookies.py as a public helper function.Also, document it in
public-api.rstThis is a very easy task for new contributors.
#enhancement #good_first_issue #help_wanted #django_modern_rest
sent via relator