Skip to content

Commit 878f31a

Browse files
authored
feat: ✨ add an example_package_properties object (#1044)
## Description I'm updating the `create_package_structure()` function and needed this object to make it easier to update the docstrings and example code throughout the package. Closes #987 <!-- Select quick/in-depth as necessary --> This PR needs a quick review. ## Checklist - [x] Updated documentation - [x] Ran `just run-all`
1 parent 284cac7 commit 878f31a

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

seedcase_sprout/core/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
from .create_resource_properties import create_resource_properties
1111
from .create_resource_structure import create_resource_structure
1212
from .edit_package_properties import edit_package_properties
13+
from .example_package_properties import example_package_properties
1314

1415
# from .delete_resource_raw_file import *
1516
# from .delete_resource_data import *
@@ -68,6 +69,8 @@
6869
"TableDialectProperties",
6970
"TableSchemaForeignKeyProperties",
7071
"TableSchemaProperties",
72+
# Example properties -----
73+
"example_package_properties",
7174
# Packages -----
7275
"create_package_structure",
7376
"edit_package_properties",
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
from seedcase_sprout.core.properties import (
2+
ContributorProperties,
3+
LicenseProperties,
4+
PackageProperties,
5+
)
6+
7+
example_package_properties = PackageProperties(
8+
name="example-package",
9+
title="Example fake data package",
10+
description="Data from a fake data package on something.",
11+
contributors=[
12+
ContributorProperties(
13+
title="Jamie Jones",
14+
email="jamie_jones@example.com",
15+
roles=["creator"],
16+
)
17+
],
18+
licenses=[
19+
LicenseProperties(
20+
name="ODC-BY-1.0",
21+
path="https://opendatacommons.org/licenses/by",
22+
title="Open Data Commons Attribution License 1.0",
23+
)
24+
],
25+
)

0 commit comments

Comments
 (0)