Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/openbb apachebeam #6679

Merged

Conversation

mmistroni
Copy link
Contributor

Pull Request Template for OpenBB Developers

  1. Title:

    • [Example] - Sample for running OBB code within an Apache Beam pipeline
  2. Why? (1-3 sentences or a bullet point list):

    • A nice way to leverage OBB functions for automated workflows
  3. What? (1-3 sentences or a bullet point list):

    • A simple Apache beam dataflow pipeline ran via an unit test
  4. Impact (1-2 sentences or a bullet point list):

    • None. this is just a sample
  5. Testing Done:

    • Code runs in an unit test
  6. Reviewer Notes (optional):

    • Done amendments as suggested by @deeleeramone : depends on obb yfinance and revised README and instructions

    • Example: "Please check algorithm compatibility with existing data models."

  7. Any other information (optional)

- You need to create a Conda environment (or a virtual env) using requirements.txt in this directory
- The script exercise 3 OBB endpoints, all of which require no credentials
- Run the test from the main directory
(obb-dataflow) C:\Users\Marco And Sofia\tmp\OBBDataflowSample>python -m unittest .\tests\test_obb_pipeline.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should go in a code block, and we don't want to include anything that isn't exactly what anyone needs to enter on the command line.

python -m unittest tests/test_obb_pipeline.py

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure, thanks, apologies i will bear in mind for next time

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mmistroni This really looks great. I would like to merge this.

Could you please update the markdown like @deeleeramone mentioned?

instead of the line that says

(obb-dataflow) C:\Users\Marco And Sofia\tmp\OBBDataflowSample>python -m unittest .\tests\test_obb_pipeline.py

put

python -m unittest tests/test_obb_pipeline.py

Copy link
Contributor

@piiq piiq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will approve it, but I it would be great that the path mentioned in the comment to be removed before this is merged

- You need to create a Conda environment (or a virtual env) using requirements.txt in this directory
- The script exercise 3 OBB endpoints, all of which require no credentials
- Run the test from the main directory
(obb-dataflow) C:\Users\Marco And Sofia\tmp\OBBDataflowSample>python -m unittest .\tests\test_obb_pipeline.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mmistroni This really looks great. I would like to merge this.

Could you please update the markdown like @deeleeramone mentioned?

instead of the line that says

(obb-dataflow) C:\Users\Marco And Sofia\tmp\OBBDataflowSample>python -m unittest .\tests\test_obb_pipeline.py

put

python -m unittest tests/test_obb_pipeline.py

@mmistroni
Copy link
Contributor Author

mmistroni commented Sep 24, 2024 via email

@mmistroni
Copy link
Contributor Author

i have committed a version with fixes you require... pls advise if all good o/w will address it tomorrow morning. sorry abt this

@piiq
Copy link
Contributor

piiq commented Sep 26, 2024

@deeleeramone I'm good with the changes, feel free to merge once you take a look at it.

@deeleeramone deeleeramone added this pull request to the merge queue Sep 26, 2024
Merged via the queue into OpenBB-finance:develop with commit a14e0cf Sep 26, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants