Add more documentation to onboard ppl - Githubissues

finic-ai / doctran

MIT License

479 stars 42 forks source link

Add more documentation to onboard ppl #2

Open meryemchafry opened 1 year ago

meryemchafry commented 1 year ago

** Requirements

python .. required (upgrade to 3.10)
poetry .. required (using same version of python)
OpenAI key to test

** Installation

poetry install && poetry shell

** Tests

Show how to test --> get your emails in a folder etc..
Show expected results from tests - show examples--> Add a Readme for each test
Maybe Add notebooks for each tests

** More

Add links to understand the library hierarchy
Add links to OpenAI function calling tutos and stuff