Project

Profile

Help

Issue #3539

Install drf_openapi when installing pulp3

Added by kersom over 1 year ago. Updated 8 months ago.

Status:
CLOSED - WONTFIX
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
Start date:
Due date:
Severity:
1. Low
Version:
Platform Release:
Blocks Release:
OS:
Backwards Incompatible:
No
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Easy Fix
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:

Description

Right now, in order to have access to auto generated docs, it is necessary an extra step to install drf_openapi

 pip3 install -e git+https://github.com/limdauto/drf_openapi.git@54d24fb#egg=drf_openapi

I would like to suggest this extra step to be removed, and drf_openapi be installed together with pulp.


Related issues

Related to Packaging - Task #3533: Prepare for pypi pulp3 beta release MODIFIED Actions

History

#1 Updated by bizhang over 1 year ago

I suggest we use setuptools' extra_requires module [0]
Users can then install pulp like: pip install pulpcore['autodocs'] if they wish for pulpcore with autodocs, and pip install pulpcore if they do not

[0] http://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras-optional-features-with-their-own-dependencies

#2 Updated by daviddavis over 1 year ago

  • Groomed changed from No to Yes
  • Sprint Candidate changed from No to Yes

#3 Updated by daviddavis over 1 year ago

  • Groomed changed from Yes to No
  • Sprint Candidate changed from Yes to No

@bizhang, does this also work when installing pulpcore from source?

#4 Updated by bizhang over 1 year ago

Yep!
pip install -e .['test'] for local installs
pip3 install -e "git+https://github.com/werwty/pulp.git@3.0-dev#egg=pulpcore[test]&subdirectory=plugin" for remote

#5 Updated by bizhang over 1 year ago

  • Related to Task #3533: Prepare for pypi pulp3 beta release added

#6 Updated by bmbouter over 1 year ago

In terms of a mechanism, I think having the optional setuptools approach is right.

I also want to hear feedback on this question: should all Pulp installations ship with local API docs by default?

#7 Updated by daviddavis over 1 year ago

I also want to hear feedback on this question: should all Pulp installations ship with local API docs by default?

Seems easier to just have a central place for users to see their api schema for their particular set up rather than having to hunt down the docs online for core, plugins, etc; and then have to look up what versions of things that are being used, etc.

Are there any downsides?

#8 Updated by dalley over 1 year ago

  • Triaged changed from No to Yes
  • Sprint set to Sprint 35
  • Tags Easy Fix added

#9 Updated by bizhang over 1 year ago

When I think of dependencies I think of things that pulp must have in order to run.

Tools like drf_openapi/drf_yawg is nice to have but not necessary; the schema is still available to the user when they GET /api/v3/; all this optional dependencies provide is a nice UI wrapper on top.

#10 Updated by dalley over 1 year ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to dalley

#11 Updated by dalley over 1 year ago

  • Status changed from ASSIGNED to POST

#12 Updated by dalley over 1 year ago

  • Status changed from POST to CLOSED - WONTFIX

#13 Updated by dalley over 1 year ago

#14 Updated by dalley over 1 year ago

  • Assignee deleted (dalley)
  • Sprint deleted (Sprint 35)

#15 Updated by daviddavis 8 months ago

  • Sprint/Milestone set to 3.0

#16 Updated by bmbouter 8 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF