cookiecutter-pathway
Cookiecutter Pathway is a framework for jumpstarting production-ready Pathway projects quickly.
File Explorer
Download Latest Version (.zip)- bug_report.yml
- config.yml
- .env
- __init__.py
- test_pipeline.py
- __init__.py
- config.py
- input.py
- output.py
- pipeline.py
- Dockerfile
- local.yml
- prod.yml
- pyproject.toml
- README.md
- requirements-common.txt
- requirements-dev.txt
- requirements-prod.txt
- run.py
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- cookiecutter.json
- LICENSE
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/pathwaycom/cookiecutter-pathway
Downloads the entire project code from GitHub to your computer.
cd cookiecutter-pathway
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f {{cookiecutter.project_slug}}/Dockerfile -t cookiecutter-pathway .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 cookiecutter-pathway
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Python
EasyPrerequisites
$ pip install "cookiecutter>=1.7.0"
Installs the Python libraries listed in requirements.txt (or similar).
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)