dataset-prep 0.1.0__tar.gz

dataset_prep-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,49 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+name: Upload Python Package
+on:
+  release:
+    types: [published]
+permissions:
+  contents: read
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Build package for distribution
+        run: uv build
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # include PyPI project URL in the deployment status:
+      url: https://pypi.org/project/dataset-prep
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

dataset_prep-0.1.0/.gitignore

@@ -0,0 +1,44 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+docs/_build/
+
+# Environments
+.tox
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# code coverage
+.coverage
+coverage.xml
+
+# jupyter
+.ipynb_checkpoints/

dataset_prep-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,61 @@
+# This configuration file specifies which hooks to run (ruff, prettier, and codespell), the versions of each tool, arguments to pass, and which file types to include or exclude.
+# It ensures that code is linted, formatted, and checked for spelling and quality issues automatically on every commit.
+# To set up, run 'pre-commit install'. You can also run all hooks manually with 'pre-commit run --all-files'.
+repos:
+  # Ruff linter and formatter
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.7
+    hooks:
+      # Run the linter
+      - id: ruff-check
+        args: [--fix] # To enable lint fixes
+      # Run the formatter using configs in pyproject.toml
+      - id: ruff-format
+  # yamlfmt for formatting YAML files
+  - repo: https://github.com/google/yamlfmt
+    rev: v0.17.2
+    hooks:
+      - id: yamlfmt
+  # mdformat for formatting Markdown files
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.22
+    hooks:
+      - id: mdformat
+        # Add mkdocs/frontmatter plugins to fix snippet formatting issues
+        additional_dependencies:
+          - mdformat-mkdocs
+          - mdformat-frontmatter
+          - mdformat-pyproject # support configuration in pyproject.toml
+        args: [--wrap, keep]
+        # Temporarily exclude docs/api/index.md due because it messes up the formatting
+        exclude: ^docs/api/index\.md$
+  # Codespell for spell checking
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        exclude_types: ["xml"] # ignore sample xml file
+        # ignore German "archiv" in URLs; ignore german content in TEI input test
+        args: [--uri-ignore-words-list=archiv, --skip=tests/test_sentence/test_corpus/test_tei_input.py]
+  # Common file checks (no dependencies)
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-yaml
+        # Allow unknown custom tags like !relative used by mkdocs.yml
+        args: [--unsafe]
+      - id: check-toml
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-merge-conflict
+  # Make sure uv.lock file is up to date
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    # uv version.
+    rev: 0.8.6
+    hooks:
+      - id: uv-lock
+  # validate GitHub Actions workflow files
+  - repo: https://github.com/mpalmer/action-validator
+    rev: v0.8.0
+    hooks:
+      - id: action-validator

dataset_prep-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

dataset_prep-0.1.0/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+## [0.1] - 2026-02-02
+
+Preliminary package with readme-info script and basic usage instructions.
+
+[0.1]: https://github.com/Princeton-CDH/dataset-prep/tree/0.1

dataset_prep-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dataset_prep-0.1.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: dataset-prep
+Version: 0.1.0
+Summary: Utilities for preparing datasets for publication
+License: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Requires-Python: >=3.12
+Requires-Dist: frictionless>=5.18.1
+Requires-Dist: polars>=1.36.1
+Requires-Dist: requests>=2.32.5
+Description-Content-Type: text/markdown
+
+# dataset-prep
+
+This python package provides utilities for prepping datasets for publication,
+building on the [Frictionless data](https://frictionlessdata.io/) framework
+and [corresponding python package](https://framework.frictionlessdata.io/).
+
+This package is currently in alpha status and provides a script for generating field-level
+information from a frictionless datapackage file for inclusion in a dataset readme (plain text)
+or accompanying data dictionary (CSV). The script assumes you have already created a
+[datapackage](https://datapackage.org/) to describe your dataset.
+
+[![PyPI - Version](https://img.shields.io/pypi/v/dataset-prep)](https://pypi.org/project/dataset-prep/)
+[![Apache 2 License](https://img.shields.io/badge/license-Apache%20License%202.0-blue)](#license)
+
+## Basic Usage
+
+Install the package from python using your preferred method (`pip` or `uv`):
+
+```console
+pip install dataset-prep
+```
+
+Run the `dataset-readme-info` script with a path to your datapackage file. The data files
+referenced in the datapackage must be present at the path specified.
+
+> [!NOTE]
+> We highly recommend running `frictionless validate` on your datapackage to
+> ensure your dataset and your datapackage agree on the structure of your data!
+
+To generate a plain-text list of fields with the descriptions in the datapackage file:
+
+```console
+dataset-readme-info my-dataset/datapackage.json
+```
+
+The script will output text content to the console, which can be copied and pasted
+into the readme for your dataset.
+
+To generate a CSV data dictionary with field information (description, type, name)
+for each resource described in the datapackage file, specify the path where
+the file should be generated:
+
+```console
+dataset-readme-info my-dataset/datapackage.json --data-dictionary my-dataset/datadictionary.csv
+```
+
+Use the `-h` or `--help` option for script usage.
+
+### Examples
+
+The dataset-readme-info script is generalized from one that was used to help prepare datasets from
+the [Shakespeare and Company Project](https://shakespeareandco.princeton.edu/) for publication.
+
+The 2.0 version of the data published in 2025 includes a CSV data dictionary:
+
+> Koeser, Rebecca Sutton & Kotin, Joshua. (2025). Shakespeare and Company Project Datasets [Data set]. Version 2. Princeton University. [https://doi.org/10.34770/kf6c-b079](https://doi.org/10.34770/kf6c-b079)
+
+The 1.2 version of the data published in 2022 includes field details in the README:
+
+> Kotin, Joshua, Koeser, Rebecca Sutton, et al. (2022). Shakespeare and Company Project Dataset: Lending Library Members, Books, Events [Data set]. Version 1.2. Princeton University. [https://doi.org/10.34770/dtqa-2981](https://doi.org/10.34770/dtqa-2981)
+
+## License
+
+This project is licensed under the [Apache 2.0 License](LICENSE).
+
+(c)2025 Trustees of Princeton University. Permission granted for non-commercial
+distribution online under a standard Open Source license.

dataset_prep-0.1.0/README.md

@@ -0,0 +1,67 @@
+# dataset-prep
+
+This python package provides utilities for prepping datasets for publication,
+building on the [Frictionless data](https://frictionlessdata.io/) framework
+and [corresponding python package](https://framework.frictionlessdata.io/).
+
+This package is currently in alpha status and provides a script for generating field-level
+information from a frictionless datapackage file for inclusion in a dataset readme (plain text)
+or accompanying data dictionary (CSV). The script assumes you have already created a
+[datapackage](https://datapackage.org/) to describe your dataset.
+
+[![PyPI - Version](https://img.shields.io/pypi/v/dataset-prep)](https://pypi.org/project/dataset-prep/)
+[![Apache 2 License](https://img.shields.io/badge/license-Apache%20License%202.0-blue)](#license)
+
+## Basic Usage
+
+Install the package from python using your preferred method (`pip` or `uv`):
+
+```console
+pip install dataset-prep
+```
+
+Run the `dataset-readme-info` script with a path to your datapackage file. The data files
+referenced in the datapackage must be present at the path specified.
+
+> [!NOTE]
+> We highly recommend running `frictionless validate` on your datapackage to
+> ensure your dataset and your datapackage agree on the structure of your data!
+
+To generate a plain-text list of fields with the descriptions in the datapackage file:
+
+```console
+dataset-readme-info my-dataset/datapackage.json
+```
+
+The script will output text content to the console, which can be copied and pasted
+into the readme for your dataset.
+
+To generate a CSV data dictionary with field information (description, type, name)
+for each resource described in the datapackage file, specify the path where
+the file should be generated:
+
+```console
+dataset-readme-info my-dataset/datapackage.json --data-dictionary my-dataset/datadictionary.csv
+```
+
+Use the `-h` or `--help` option for script usage.
+
+### Examples
+
+The dataset-readme-info script is generalized from one that was used to help prepare datasets from
+the [Shakespeare and Company Project](https://shakespeareandco.princeton.edu/) for publication.
+
+The 2.0 version of the data published in 2025 includes a CSV data dictionary:
+
+> Koeser, Rebecca Sutton & Kotin, Joshua. (2025). Shakespeare and Company Project Datasets [Data set]. Version 2. Princeton University. [https://doi.org/10.34770/kf6c-b079](https://doi.org/10.34770/kf6c-b079)
+
+The 1.2 version of the data published in 2022 includes field details in the README:
+
+> Kotin, Joshua, Koeser, Rebecca Sutton, et al. (2022). Shakespeare and Company Project Dataset: Lending Library Members, Books, Events [Data set]. Version 1.2. Princeton University. [https://doi.org/10.34770/dtqa-2981](https://doi.org/10.34770/dtqa-2981)
+
+## License
+
+This project is licensed under the [Apache 2.0 License](LICENSE).
+
+(c)2025 Trustees of Princeton University. Permission granted for non-commercial
+distribution online under a standard Open Source license.

dataset_prep-0.1.0/dataset_prep/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

dataset_prep-0.1.0/dataset_prep/readme_info.py

@@ -0,0 +1,126 @@
+#!/usr/bin/env python
+
+# utility script to generate readme information based on CSV and datapackage
+#
+
+import argparse
+import csv
+import pathlib
+
+import polars as pl
+from frictionless import Package, Resource
+
+
+def readme_info(
+    dpkg_resource: Resource, filepath: pathlib.Path, field_list: bool = True
+) -> None:
+    # print out summary information for inclusion in a plain text readme file
+
+    # open the data file at the specified path based on the format in the resource
+    match dpkg_resource.format:
+        case "csv":
+            df = pl.scan_csv(filepath)
+        case "json":
+            df = pl.read_json(filepath, infer_schema_length=1000)
+        case "jsonl":
+            # polars handles compression automatically
+            df = pl.scan_ndjson(filepath)
+        case _:
+            raise ValueError(f"Unsupported format: {dpkg_resource.format}")
+
+    print(f"\n\nDATA-SPECIFIC INFORMATION FOR: {dpkg_resource.path}\n\n")
+
+    df_columns = df.collect_schema().names()
+    print(f"1. Number of fields: {len(df_columns)}\n")
+
+    # calculate total rows for lazy-loaded csv/jsonl
+    if isinstance(df, pl.LazyFrame):
+        num_rows = df.select(pl.len()).collect().item()
+    else:
+        # otherwise, use height
+        num_rows = df.height
+    print(f"2. Number of rows: {num_rows:,}\n")
+    schema_fields = dpkg_resource.schema.fields
+
+    # check that datapackage and data file agree
+    assert len(schema_fields) == len(df_columns)
+    field_info = {field.name: field for field in schema_fields}
+
+    # output details about fields when requested
+    if field_list:
+        print("3. Field List:\n")
+        for col in df_columns:
+            print("%s : %s" % (col, field_info[col].description))
+
+
+def data_dictionary(datapackage: Package, output_path: pathlib.Path) -> None:
+    print(f"\n\nWriting data dictionary to {output_path}")
+    with output_path.open("w", encoding="utf-8") as csv_datadict:
+        fieldnames = [
+            "Filename",
+            "Variable",
+            "Variable name",
+            "Description",
+            "Type",
+            "Format",
+        ]
+        csvwriter = csv.DictWriter(csv_datadict, fieldnames=fieldnames)
+        csvwriter.writeheader()
+        for resource in datapackage.resources:
+            for field in resource.schema.fields:
+                csvwriter.writerow(
+                    {
+                        "Filename": resource.path,
+                        "Variable": field.title,
+                        "Variable name": field.name,
+                        "Description": field.description,
+                        "Type": field.type,
+                        "Format": field.format,
+                    }
+                )
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        "Generate dataset info readme from datapackage and data files"
+    )
+    parser.add_argument("datapackage", type=pathlib.Path)
+    # flag to determine whether fields be listed
+    parser.add_argument(
+        "--field-list",
+        help="Generate field list in readme.txt format",
+        action=argparse.BooleanOptionalAction,
+        default=True,
+    )
+    parser.add_argument(
+        "-dd",
+        "--data-dictionary",
+        help="Create a data dictionary in the specified file",
+        type=pathlib.Path,
+    )
+
+    args = parser.parse_args()
+
+    if args.data_dictionary:
+        if args.data_dictionary.exists():
+            print(
+                f"Requested data dictionary file {args.data_dictionary} already exists"
+            )
+            raise SystemExit(1)
+
+    # open the specified path as a datapackage
+    datapackage = Package(args.datapackage)
+
+    for resource in datapackage.resources:
+        # assume resource path is relative to the datapackage file
+        datafile = args.datapackage.parent / resource.path
+        # generate summary information for inclusion in a plain text readme file
+        readme_info(resource, datafile, field_list=args.field_list)
+
+    # if data dictionary is requested, create it based on info in datapackage file
+    if args.data_dictionary:
+        data_dictionary(datapackage, args.data_dictionary)
+
+
+if __name__ == "__main__":
+    main()