[Feature] Add form_13f Endpoint to equity.ownership

[deeleeramone]

1. Why? (1-3 sentences or a bullet point list):

Form 13F-HR submissions are newsworthy events, happening every calendar quarter. This is the time of year that Michael Burry remains relevant, or Berkshire Hathaway.

2. What? (1-3 sentences or a bullet point list):

   • obb.equity.ownership.form_13f()

   • Data is available quarterly, by calendar year, to 2013-06-30.

   • The symbol parameter accepts either, a stock ticker or CIK.

   • The date parameter returns the filing for the quarter ending the date entered, and overrides the limit param.

   • The limit parameter returns the most recent N number of reports.

3. Impact (1-2 sentences or a bullet point list):

   • Not a breaking change.

   • Improved data coverage.

4. Testing Done:

   • Integration and unit tests added.

   • Variety of symbols and CIKs with limit/date combinations.

5. Any other information (optional)
   

[the-praxs]

Thank you for adding another insightful endpoint to our Platform!

I have left some comments that cater to code quality. Also, I would kindly request to add comments in the code to indicate why that particular LOC/snippet is needed. This will make it for other developers to understand them.

[deeleeramone]

Also, I would kindly request to add comments in the code to indicate why that particular LOC/snippet is needed. This will make it for other developers to understand them.

Thanks for the review, I have added some comments to the parse_13f.py file. Is that what you were looking for?

[the-praxs]

Also, I would kindly request to add comments in the code to indicate why that particular LOC/snippet is needed. This will make it for other developers to understand them.

Thanks for the review, I have added some comments to the parse_13f.py file. Is that what you were looking for?

Yes. Thank you.

[the-praxs]

Everything's fine except the warning being used to inform the source of the data. If it's necessary it must be displayed/rendered in a better way.

I would also request to update the static once again, since there was a minor tweak added.

[deeleeramone]

Warning is not a good method to inform the user about the exact source of the data. The extra I am talking about is the OBBject extra attribute.

Do we have anything documented that outlines what this is and how to use it?

[the-praxs]

Warning is not a good method to inform the user about the exact source of the data. The extra I am talking about is the OBBject extra attribute.

Do we have anything documented that outlines what this is and how to use it?

Extra -> https://docs.openbb.co/platform/development/developer-guidelines/obbject

[deeleeramone]

Warning is not a good method to inform the user about the exact source of the data. The extra I am talking about is the OBBject extra attribute.

Do we have anything documented that outlines what this is and how to use it?

Extra -> https://docs.openbb.co/platform/development/developer-guidelines/obbject

This is does not tell you how to inject something there, or anything at all other than a very basic definition of the field in the OBBject.

[the-praxs]

Warning is not a good method to inform the user about the exact source of the data. The extra I am talking about is the OBBject extra attribute.

Do we have anything documented that outlines what this is and how to use it?

Extra -> https://docs.openbb.co/platform/development/developer-guidelines/obbject

This is does not tell you how to inject something there, or anything at all other than a very basic definition of the field in the OBBject.

Warning is not a good method to inform the user about the exact source of the data. The extra I am talking about is the OBBject extra attribute.

Do we have anything documented that outlines what this is and how to use it?

Extra -> https://docs.openbb.co/platform/development/developer-guidelines/obbject

This is does not tell you how to inject something there, or anything at all other than a very basic definition of the field in the OBBject.

Currently we don't have a way to do it. In the future we might if it warrants a strong need.

[deeleeramone]

Currently we don't have a way to do it. In the future we might if it warrants a strong need.

So until there is a way to do it, I will continue to use warnings, because that is better than nothing. You can turn off warnings, or with to_df() you won't even see them. There is absolutely a strong need for being able to communicate metadata from the provider fetcher to the OBBject that doesn't involve applying it to every single instance of the results object.

[the-praxs]

Currently we don't have a way to do it. In the future we might if it warrants a strong need.

So until there is a way to do it, I will continue to use warnings, because that is better than nothing. You can turn off warnings, or with to_df() you won't even see them. There is absolutely a strong need for being able to communicate metadata from the provider fetcher to the OBBject that doesn't involve applying it to every single instance of the results object.

Why must this particular endpoint among others should display the source url? What is the critical need for the user to know this? How is the user going to benefit from this information?

I believe that using warnings as a workaround method to display the source url for the data is not a good practice. Warnings are supposed to convey to the user about possible issues but here this is not an issue.

@IgorWounds @montezdesousa thoughts please?

[montezdesousa]

I agree that warnings are a bad place to display that.

What's the practical use case for this feature at the moment? If it's not a common issue I'd wait to have a proper place to put it.

[deeleeramone]

I agree that warnings are a bad place to display that.

What's the practical use case for this feature at the moment? If it's not a common issue I'd wait to have a proper place to put it.

Metadata, I cannot stress this enough and have been saying it from the beginning. This is super practical, and extremely useful - i.e., FRED series. You need to know what the units are, along with other things related to the series and you absolutely do not want to serialize this across every row of data.

[the-praxs]

LGTM 🚀