microsoft / data-factory-testing-framework

A stand-alone test framework that allows to write unit tests for Data Factory pipelines on Microsoft Fabric, Azure Data Factory and Azure Synapse Analytics.
MIT License
92 stars 21 forks source link

Improve getting started documentation #136

Open arjendev opened 1 month ago

arjendev commented 1 month ago

I don't think the getting started is in a well enough shape to guide a citizen developer and thus I don't want to highlight it in the main README for now. If people have no exposure before to Python, the current getting started does not explain the following topics well enough:

  1. Mention python needs to be installed
  2. Selecting the Python interpreter in vscode
  3. How to write your first test
  4. How to run a test with test explorer / pytest
  5. Should we guide the user through setting up a requirements.txt?
  6. Should we guide the user in setting up a venv?