feat: ✨ add create_package_structure()
#754
Open
+98
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
first version of both function and test
## Description Closes #638 ## Reviewer Focus <!-- Select quick/in-depth as necessary --> This PR needs a quick review. It's pretty simple :) --------- Co-authored-by: Kris Beicher <[email protected]>
## Description This renames `create_properties_object()` to `create_default_package_properties()` because it seemed more descriptive. ## Reviewer Focus <!-- Select quick/in-depth as necessary --> This PR needs a quick review. ## Checklist - [x] Added or updated tests - [x] Tests passed locally - [x] Linted and formatted code - [x] Build passed locally - [x] Updated documentation
lwjohnst86
approved these changes
Oct 8, 2024
lwjohnst86
changed the title
create_package_structurecreate_package_structure()
K-Beicher
reviewed
Oct 8, 2024
signekb
requested changes
Oct 9, 2024
Comment on lines
+43
to
+46
| readme_path = create_readme_path(package_path) | ||
| properties_path = create_properties_path(package_path) | ||
| properties = create_default_package_properties() | ||
| readme = create_readme_text(properties) |
There was a problem hiding this comment.
This is nitpicking, but I think the order of these would be nicer if they were:
Suggested change
| readme_path = create_readme_path(package_path) | |
| properties_path = create_properties_path(package_path) | |
| properties = create_default_package_properties() | |
| readme = create_readme_text(properties) | |
| properties = create_default_package_properties() | |
| properties_path = create_properties_path(package_path) | |
| readme = create_readme_text(properties) | |
| readme_path = create_readme_path(package_path) |
So they are "grouped" in the sense that first properties are handled, then the README. It also matches the order that they are used in the return statement :)
| assert readme_path.read_text() | ||
|
|
||
|
|
||
| def test_throws_if_directory_does_not_exist(tmp_path): |
There was a problem hiding this comment.
Suggested change
| def test_throws_if_directory_does_not_exist(tmp_path): | |
| def test_throws_error_if_directory_does_not_exist(tmp_path): |
? :)
| create_package_structure(tmp_path / "nonexistent") | ||
|
|
||
|
|
||
| def test_throws_if_path_points_to_file(tmp_path): |
There was a problem hiding this comment.
Suggested change
| def test_throws_if_path_points_to_file(tmp_path): | |
| def test_throws_error_if_path_points_to_file(tmp_path): |
| to provide the correct path location. | ||
| Returns: | ||
| A list of paths to the created files. |
There was a problem hiding this comment.
Suggested change
| A list of paths to the created files. | |
| A list of paths to the two created files: The datapackage.json and the README.md. |
I think it would be nice to be more specific here :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This adds the
create_package_structure()function.Closes #619
Reviewer Focus
This PR needs an in-depth review.
Checklist