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] Add Open Finance (Sistema Financeiro Aberto) participants #140

Open
guibranco opened this issue Jun 26, 2023 · 2 comments
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request gitauto good first issue Good for newcomers hacktoberfest HACKTOBERFEST Accepted PR help wanted Extra attention is needed .NET ℹ️ new source Request of a new source of data or new properties in the schema

Comments

@guibranco
Copy link
Owner

guibranco commented Jun 26, 2023

Add data from SFA - Open Finance

Documenation of the file format.


Contributing

Here is a step-by-step on how to add a new source of data to the merge tool:

  • Check out MergeTool.
  • Open VS, VS Code, Rider, or your favorite IDE / Code Editor for .NET projects.
  • Load the project (currently, it is in C# .NET 8.0).
  • Add the required URLs to the Constants.cs file.
  • Add a new enum item in the Source.cs file. Please use the source system acronyms whenever possible.
  • Add a new method in the Reader.cs called Load[NewSystemAcronym]. This should do all the heavy job of grabbing the information from the remote source.
  • Follow the other methods patterns to extract the PDF information from the file if the new source provides a PDF file.
  • Implements the data extraction the way you prefer if it is not a PDF file.
  • Add the RegExp to the Patterns.cs file if you need to use RegExp to extract data.
  • Add the new field(s) to the Bank.cs file.
  • In the Seeder.cs file, implement the method Merge[NewSystemAcronym] to merge the new data with the existing ones. I prefer to filter the data by ISPB and then Document to check for existing data. Rely on the existing list, DO NOT ADD new bank to the list if it is not present with COMPE, ISPB, Document, and Name at least. These are mandatory fields, if you have all this information, and you did not find the bank on the existing list, feel free to add it to the list. (Let me know this in the PR comment).
  • Call the new methods (Load[NewSystemAcronym]r and Merge[NewSystemAcronym]) in the AcquireData method inside the Program.cs file.
  • On the Writer.cs file, edit the following methods, mapping the new field(s):
    • SaveCsv
    • SaveMarkdown
    • SaveSql
  • Test it 🧪
  • Commit and submit a PR 🎉

Testing

  • You can run the application locally without submitting any changes to this repository.
  • Run how many times you need, it will only generate some files in the output directory inside result directory.
@github-actions github-actions bot added the .NET label Jun 26, 2023
@guibranco guibranco added enhancement New feature or request dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Jun 28, 2023
@guibranco guibranco self-assigned this Jul 27, 2023
@guibranco guibranco removed help wanted Extra attention is needed good first issue Good for newcomers labels Jul 27, 2023
@guibranco guibranco removed their assignment Aug 9, 2023
@guibranco guibranco added help wanted Extra attention is needed good first issue Good for newcomers ℹ️ new source Request of a new source of data or new properties in the schema labels Aug 9, 2023
@guibranco guibranco added the hacktoberfest HACKTOBERFEST Accepted PR label May 15, 2024
@guibranco guibranco changed the title Add Open Finance (Sistema Financeiro Aberto) participants [FEATURE] Add Open Finance (Sistema Financeiro Aberto) participants May 15, 2024
@guibranco guibranco transferred this issue from guibranco/BancosBrasileiros Aug 16, 2024
Copy link
Contributor

gitauto-ai bot commented Aug 16, 2024

Hello @guibranco, you have reached your request limit of 5, your cycle will refresh on 2024-08-21 10:07:38.
Consider subscribing if you want more requests.
If you have any questions or concerns, please contact us at info@gitauto.ai.

@guibranco guibranco removed the dependencies Pull requests that update a dependency file label Sep 16, 2024
@gitauto-ai gitauto-ai bot added the gitauto label Sep 23, 2024
Copy link
Contributor

gitauto-ai bot commented Sep 23, 2024

Sorry, we have an error. Please try again.

Have feedback or need help?
Feel free to email info@gitauto.ai.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request gitauto good first issue Good for newcomers hacktoberfest HACKTOBERFEST Accepted PR help wanted Extra attention is needed .NET ℹ️ new source Request of a new source of data or new properties in the schema
Projects
None yet
Development

No branches or pull requests

1 participant