Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate away from abandoned coreapi/coreschema dependency #60

Open
johnthagen opened this issue Oct 18, 2020 · 1 comment
Open

Migrate away from abandoned coreapi/coreschema dependency #60

johnthagen opened this issue Oct 18, 2020 · 1 comment
Labels
Upstream Migrate issue to drf-yasg

Comments

@johnthagen
Copy link

johnthagen commented Oct 18, 2020

Upsteam issues:

From the core-api repo:

DEPRECATION NOTICE: As of djangorestframework 3.9, the plan is to phase out CoreAPI in favor of OpenAPI as the default schema representation. New projects should consider using OpenAPI rather than CoreAPI. See the DRF 3.9 release announcment for more details.

DRF will soon be raising deprecation warnings for CoreAPI schemas and they will be removed in DRF 3.14. I haven't looked closely enough at drf-yasg2 to know if this will affect this package, or if we only rely on coreapi directly rather than through DRF itself.

The coreapi Python package is frozen and has not seen a release in 3 years. It was last tested on Python 3.6. This is a liability for the long term health of this project. This upstream issue would have broken drf-yasg[2] on Python 3.10, but a maintainer took over one of coreapi's frozen dependencies, itypes and fixed the issue.

Another benefit of removing the dependency on coreapi is that coreapi depends on requests, which depends on chardet. chardet is LGPL licensed which presents problems for developers wanting to package their application as a binary using PyInstaller or PyOxidizer (psf/requests#4417).

Seems like we should try to identify and migrate over the parts of coreapi that are needed for drf-yasg2.

coreapi also brings in coreschema which is used by drf-yasg2. coreschema has also not been maintained for 3 years.

@johnthagen
Copy link
Author

johnthagen commented Oct 18, 2020

coreapi

"coreapi>=2.3.3",

from coreapi.compat import urlparse

from coreapi.compat import force_bytes

from coreapi.compat import urlparse

coreschema

"coreschema>=0.0.4",

@johnthagen johnthagen changed the title Migrate away from deprecated coreapi dependency Migrate away from abandoned coreapi/coreschema dependency Oct 18, 2020
@JoelLefkowitz JoelLefkowitz added Upstream Migrate issue to drf-yasg and removed 1.20 labels Oct 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Upstream Migrate issue to drf-yasg
Projects
None yet
Development

No branches or pull requests

2 participants