Project

Profile

Help

Issue #3539

closed

Install drf_openapi when installing pulp3

Added by kersom over 4 years ago. Updated over 3 years ago.

Status:
CLOSED - WONTFIX
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
Start date:
Due date:
Estimated time:
Severity:
1. Low
Version:
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Easy Fix
Sprint:
Quarter:

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 releaseMODIFIEDbizhang

Actions
Actions #1

Updated by bizhang over 4 years 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

Actions #2

Updated by daviddavis over 4 years ago

  • Groomed changed from No to Yes
  • Sprint Candidate changed from No to Yes
Actions #3

Updated by daviddavis over 4 years ago

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

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

Actions #4

Updated by bizhang over 4 years 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

Actions #5

Updated by bizhang over 4 years ago

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

Updated by bmbouter over 4 years 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?

Actions #7

Updated by daviddavis over 4 years 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?

Actions #8

Updated by dalley over 4 years ago

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

Updated by bizhang over 4 years 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.

Actions #10

Updated by dalley over 4 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to dalley
Actions #11

Updated by dalley over 4 years ago

  • Status changed from ASSIGNED to POST
Actions #12

Updated by dalley over 4 years ago

  • Status changed from POST to CLOSED - WONTFIX
Actions #13

Updated by dalley over 4 years ago

Actions #14

Updated by dalley over 4 years ago

  • Assignee deleted (dalley)
  • Sprint deleted (Sprint 35)
Actions #15

Updated by daviddavis over 3 years ago

  • Sprint/Milestone set to 3.0.0
Actions #16

Updated by bmbouter over 3 years ago

  • Tags deleted (Pulp 3)

Also available in: Atom PDF