Automate pypi deployment

[hmoazam]

WIP for automatically publishing package to pypi and creating github release. Testpypi automation in place for package at: https://test.pypi.org/project/dspy-ai-test/

[hmoazam]

Github action for automating deployments and versioning of the dspy-ai package on PyPI.

Checklist for use included at docs/docs/release-checklist.md

Overview of the workflow:

1. Maintainer of the repo pushes a tag following semver versioning for the new release.
2. This triggers the github action which extracts the tag (the version)
3. Builds and publishes a release on test-pypi
4. Uses the test-pypi release to run build_utils/tests/intro.py with the new release as an integration test. Note intro.py is a copy of the intro notebook.
5. Assuming the test runs successfully, it pushes a release to pypi. If not, the user can delete the tag, make the fixes and then push the tag again. Versioning for multiple releases to test-pypi with the same tag version is taken care of by the workflow by appending a pre-release identifier, so the user only needs to consider the version for pypi.
6. (Currently manual) the user creates a release and includes release notes, as described in docs/docs/release-checklist.md

[ammirsm]

Great job! Thank you for your time and contribution!
Overall, this looks good to me, but here are a few suggestions:

1. It would be helpful to have a document explaining how we are building this. Including this document in the PR should be sufficient. While I have a general understanding of how it works currently, a short document connecting the dots would make it much easier to understand.
2. I've added a few comments which may help in cleaning up, but they aren't necessary.
3. Instead of copying the intro.py into the file, it might be better to move it to pytest and run it from there.

[ammirsm]

I would say let's move this to a pytest and run that test case instead of running the actual intro.py file. what do you think?

[hmoazam]

Yes that's a good call, I'll do that. Shall I put it under tests/examples?

[ammirsm]

I would say that would be a great place to put or we can move all of these tests to a new folder name tests/integration and keep them there, this way we can distinct it later to run them or not to run them where ever we want.

I think it is good to separate these integration and maybe later we want to run them in their own CI step.

[ammirsm]

I can help with setting up this one for you, it will be a little bit tricky, I will push it in another branch and add it to CI for you in couple days.

[ammirsm]

#1048

I added my initial commits here.

[ammirsm]

for keeping this file clean do you wanna move this to the .sh file?

[hmoazam]

Great job! Thank you for your time and contribution! Overall, this looks good to me, but here are a few suggestions:

1. It would be helpful to have a document explaining how we are building this. Including this document in the PR should be sufficient. While I have a general understanding of how it works currently, a short document connecting the dots would make it much easier to understand.

-> Shall I expand what I've mentioned here or is that enough detail? I also included a release-checklist.md file which contains instructions for use and prereqs.

2. I've added a few comments which may help in cleaning up, but they aren't necessary.
3. Instead of copying the intro.py into the file, it might be better to move it to pytest and run it from there.

[ammirsm]

Great job! Thank you for your time and contribution! Overall, this looks good to me, but here are a few suggestions:

1. It would be helpful to have a document explaining how we are building this. Including this document in the PR should be sufficient. While I have a general understanding of how it works currently, a short document connecting the dots would make it much easier to understand.

-> Shall I expand what I've mentioned here or is that enough detail? I also included a release-checklist.md file which contains instructions for use and prereqs.

2. I've added a few comments which may help in cleaning up, but they aren't necessary.
3. Instead of copying the intro.py into the file, it might be better to move it to pytest and run it from there.

@hmoazam I think that's a good draft but i would say

1. let's keep it somewhere in our repo as a document not a comment
2. let's add a little bit more detail like which part of the CI is doing what

All in all, great job!

Let's tweak it a little bit and merge it as soon as we can.

[hmoazam]

This PR depends on #1192 and #1048.

Once #1048 is merged in we need to:

• Update the test-intro-script task to point to the pytest at tests_integration/test_intro.py instead of build_utils/tests/intro.py
• Delete build_utils/tests/intro.py

[ammirsm]

LGTM! Thanks for the hard work here @hmoazam 🚀🥳