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

Conversation

@PSalant726
Copy link
Contributor

@PSalant726 PSalant726 commented May 26, 2022

Purpose

To support fidesops-plus, the database migrations must be included in the package published to PyPI. Additionally, it must be possible to manually specify the location of the installed package, so that the server will be able to start while importing fidesops from PyPI.

Changes

  • Add a package config section to fidesops.toml
  • Include database migrations in the published PyPI package

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 #565

Allows for manual configuration of a path to the package's `src/`
directory. This is necessary to start the fidesops server when
importing fidesops into fidesops-plus.
Also exlude `pycache` files.
@PSalant726 PSalant726 added enhancement New feature or request dev experience Enhancements to the overall DX run unsafe ci checks Triggers running of unsafe CI checks labels May 26, 2022
@PSalant726 PSalant726 self-assigned this May 26, 2022
@PSalant726 PSalant726 requested a review from sanders41 May 26, 2022 18:13
@PSalant726 PSalant726 force-pushed the add-package-dir-config branch from 11b6434 to 8dc4447 Compare May 26, 2022 19:16
Copy link
Contributor

@sanders41 sanders41 left a comment

Choose a reason for hiding this comment

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

I couple of suggestions, but not blockers.

If you make these changes you only need to pass the path when you call init_db if the path is different than the path in the config.

@PSalant726 PSalant726 force-pushed the add-package-dir-config branch from e5414a2 to a11bba8 Compare May 26, 2022 21:58
@PSalant726 PSalant726 force-pushed the add-package-dir-config branch from a11bba8 to b00cea1 Compare May 26, 2022 22:02
@PSalant726 PSalant726 requested a review from sanders41 May 26, 2022 22:02
@sanders41 sanders41 merged commit ee9730c into main May 26, 2022
@sanders41 sanders41 deleted the add-package-dir-config branch May 26, 2022 22:18
sanders41 pushed a commit that referenced this pull request Sep 22, 2022
…566)

* Add a `package` config section

Allows for manual configuration of a path to the package's `src/`
directory. This is necessary to start the fidesops server when
importing fidesops into fidesops-plus.

* Include migrations in the PyPI package

Also exlude `pycache` files.

* Check for a `/fidesops` path basename

* Update `CHANGELOG.md`

* Include required `init_db` argument everywhere

* Resolve build errors

* Use a default `package_source_dir`
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

dev experience Enhancements to the overall DX enhancement New feature or request run unsafe ci checks Triggers running of unsafe CI checks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Include DB migrations in PyPI package; allow for a manually configured package directory

3 participants