https://github.com/unstructured-io/pipeline-template

https://github.com/unstructured-io/pipeline-template

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/unstructured-io/pipeline-template
• Owner: Unstructured-IO
• License: apache-2.0
• Created: 2022-11-18T19:31:36.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-10-02T07:43:40.000Z (over 2 years ago)
• Last Synced: 2025-03-22T04:03:39.908Z (over 1 year ago)
• Language: Python
• Size: 149 KB
• Stars: 8
• Watchers: 23
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          


  



 

# Cookiecutter Template for Pipeline Family Repositories

This repository serves as a template for creating pipeline family repositories. It makes use of

[`cookiecutter`](https://github.com/cookiecutter/cookiecutter) to make the process as quick and

easy as possible.

To be clear, this is not a pipeline family repository, it is a tool for creating pipeline family

repositories.

## Getting Started

1. Initiating repo generation:

    1. Generating a repo from this template without cloning this repo:

        This repo need not be cloned to use its template functionality. To generate a new repo from template:

        1. Make sure `cookiecutter` is installed in your current environment (`pip install cookiecutter` will install it)

        1. Run `cookiecutter git@github.com:Unstructured-IO/pipeline-template.git`

    1. Generating a repo from this template after cloning this repo:

        From the base directory of the cloned repo:

        1. Run `make install`

        2. Run `make generate-repo`

1. Provide input for the different template fields

1. Open `README.md` in the base folder of the generated repo and work through the checklist