Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Patch versioneer to allow editable installs #1070

Merged
merged 2 commits into from
Aug 12, 2022
Merged

Patch versioneer to allow editable installs #1070

merged 2 commits into from
Aug 12, 2022

Conversation

sanders41
Copy link
Contributor

@sanders41 sanders41 commented Aug 12, 2022

Purpose

This patches versioneer to allow editable installs while we are waiting for a fix from the package itself. The majority of the changes here are auto formatting from black. The lines I added are on line 1608-1609:

if self.editable_mode:
    return

Changes

  • Check for editable mode and return

Checklist

  • Update CHANGELOG.md file
    • Merge in main so the most recent CHANGELOG.md file is being appended to
    • Add description within the Unreleased section in an appropriate category. Add a new category from the list at the top of the file if the needed one isn't already there.
    • Add a link to this PR at the end of the description with the PR number as the text. example: #1
  • Applicable documentation updated (guides, quickstart, postman collections, tutorial, fidesdemo, database diagram.
  • If docs updated (select one):
    • documentation complete, or draft/outline provided (tag docs-team to complete/review on this branch)
    • documentation issue created (tag docs-team to complete issue separately)
  • Good unit test/integration test coverage
  • This PR contains a DB migration. If checked, the reviewer should confirm with the author that the down_revision correctly references the previous migration before merging
  • The Run Unsafe PR Checks label has been applied, and checks have passed, if this PR touches any external services

Ticket

Fixes #

Copy link
Contributor

@PSalant726 PSalant726 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine to do temporarily, but we should create a separate issue to track the work involved in implementing a "real" fix for this - updating the versioneer, setuptools, pip (etc) dependencies and testing.

@sanders41
Copy link
Contributor Author

@PSalant726 for sure this is a temporary fix.

@PSalant726 PSalant726 added bug Something isn't working dependencies Pull requests that update a dependency file Tech Debt python Pull requests that update Python code labels Aug 12, 2022
@sanders41 sanders41 merged commit d7a2e20 into main Aug 12, 2022
@sanders41 sanders41 deleted the versioneer branch August 12, 2022 15:59
sanders41 added a commit that referenced this pull request Sep 22, 2022
* Patch versioneer to allow editable installs

* Update CHANGELOG

Co-authored-by: Paul Sanders <pau@ethyca.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working dependencies Pull requests that update a dependency file python Pull requests that update Python code Tech Debt
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants