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 from flat to src layout #572

Closed
2 tasks done
JP-Ellis opened this issue Feb 29, 2024 · 1 comment · Fixed by #568
Closed
2 tasks done

Migrate from flat to src layout #572

JP-Ellis opened this issue Feb 29, 2024 · 1 comment · Fixed by #568
Assignees
Labels
difficulty:easy A simple task appropriate for newcomers to the codebase smartbear-supported This issue is supported by SmartBear type:chore Part of regular code upkeep

Comments

@JP-Ellis
Copy link
Contributor

Have you read the Contributing Guidelines on issues?

Description

Change the directory structure such that the pact/ directory containing all Python files is relocated to src/pact/.

Has this been requested on Canny?

No response

Motivation

The src layout helps prevent a number of issues during development. A discussion by Python's packaging group of the pros can be found at https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/.

Fundamentally, it prevents import pact from finding the local pact/ directory, and ensures that the package is installed correctly (typically as an editable installation).

Have you tried building it?

No response

Self-service

  • I'd be willing to contribute this feature to Pact Python myself.
@JP-Ellis JP-Ellis added smartbear-supported This issue is supported by SmartBear difficulty:easy A simple task appropriate for newcomers to the codebase type:chore Part of regular code upkeep labels Feb 29, 2024
@JP-Ellis JP-Ellis self-assigned this Feb 29, 2024
Copy link

🤖 Great news! We've labeled this issue as smartbear-supported and created a tracking ticket in PactFlow's Jira (PACT-1867). We'll keep work public and post updates here. Meanwhile, feel free to check out our docs. Thanks for your patience!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty:easy A simple task appropriate for newcomers to the codebase smartbear-supported This issue is supported by SmartBear type:chore Part of regular code upkeep
Projects
Status: ✅ Completed
Development

Successfully merging a pull request may close this issue.

1 participant