@@ -69,7 +69,7 @@ uv run main.py
6969sp.create_properties_script(package_path.root())
7070```
7171
72- This will create a ` properties .py` file in the newly created ` scripts/ `
72+ This will create a ` package_properties .py` file in the newly created ` scripts/ `
7373folder of your data package.
7474
7575::: callout-caution
@@ -97,7 +97,7 @@ The file structure should now look like:
9797print(file_tree(package_path.root()))
9898```
9999
100- Inside the ` scripts/properties .py ` file, you will find a template for
100+ Inside the ` scripts/package_properties .py ` file, you will find a template for
101101creating the properties of your data package. It looks like:
102102
103103``` {python}
@@ -126,7 +126,7 @@ is an example of a set of properties with required fields filled in
126126
127127``` {python}
128128#| eval: false
129- properties = sp.PackageProperties(
129+ package_properties = sp.PackageProperties(
130130 name="diabetes-study",
131131 title="A Study on Diabetes",
132132 # You can write Markdown below, with the helper `sp.dedent()`.
@@ -175,13 +175,13 @@ So in your `main.py`, include this code:
175175#| eval: false
176176#| filename: "main.py"
177177import seedcase_sprout as sp
178- from scripts.properties import properties
178+ from scripts.package_properties import package_properties
179179
180180def main():
181181 # Create the properties script in default location.
182182 sp.create_properties_script()
183183 # Write properties from properties script to `datapackage.json`.
184- sp.write_properties(properties=properties )
184+ sp.write_properties(properties=package_properties )
185185
186186if __name__ == "__main__":
187187 main()
@@ -207,7 +207,7 @@ The `write_properties()` function will give an error if the
207207` PackageProperties ` object is missing some of its required fields or if
208208they are not filled in correctly. In that case, a ` datapackage.json `
209209file won't be created. So you will have to return to the
210- ` scripts/properties .py ` file and fill in the correct properties.
210+ ` scripts/package_properties .py ` file and fill in the correct properties.
211211:::
212212
213213The ` write_properties() ` function created the ` datapackage.json ` file in
@@ -233,15 +233,15 @@ data package you just created by writing it in the `main.py` file.
233233#| eval: false
234234#| filename: "main.py"
235235import seedcase_sprout as sp
236- from scripts.properties import properties
236+ from scripts.package_properties import package_properties
237237
238238def main():
239239 # Create the properties script in default location.
240240 sp.create_properties_script()
241241 # Save the properties to `datapackage.json`.
242- sp.write_properties(properties=properties )
242+ sp.write_properties(properties=package_properties )
243243 # Create text for a README of the data package.
244- readme_text = sp.as_readme_text(properties )
244+ readme_text = sp.as_readme_text(package_properties )
245245 # Write the README text to a `README.md` file.
246246 sp.write_file(readme_text, sp.PackagePath().readme())
247247
0 commit comments