Load Apache Fineract data in Python using dltHub

Build a Apache Fineract-to-database or-dataframe pipeline in Python using dlt with automatic Cursor support.

In this guide, we'll set up a complete Apache Fineract data pipeline from API credentials to your first data load in just 10 minutes. You'll end up with a fully declarative Python pipeline based on dlt's REST API connector, like in the partial example code below:

Example code
@dlt.source def apache_fineract_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://Domain Name/api/v1/", "auth": { "type": "query", "token_param": "access_token", "token": base64EncodedAuthenticationKey, }, }, "resources": [ accounts/share, provisioningcriteria ], } [...] yield from rest_api_resources(config) def get_data() -> None: # Connect to destination pipeline = dlt.pipeline( pipeline_name='apache_fineract_pipeline', destination='duckdb', dataset_name='apache_fineract_data', ) # Load the data load_info = pipeline.run(apache_fineract_source()) print(load_info)

Why use dltHub Workspace with LLM Context to generate Python pipelines?

  • Accelerate pipeline development with AI-native context
  • Debug pipelines, validate schemas and data with the integrated Pipeline Dashboard
  • Build Python notebooks for end users of your data
  • Low maintenance thanks to Schema evolution with type inference, resilience and self documenting REST API connectors. A shallow learning curve makes the pipeline easy to extend by any team member
  • dlt is the tool of choice for Pythonic Iceberg Lakehouses, bringing mature data loading to pythonic Iceberg with or without catalogs

What you’ll do

We’ll show you how to generate a readable and easily maintainable Python script that fetches data from apache_fineract’s API and loads it into Iceberg, DataFrames, files, or a database of your choice. Here are some of the endpoints you can load:

  • Accounts Management: Create, retrieve, and manage client accounts and sharing permissions
  • Provisioning Criteria: Define and manage provisioning rules and criteria for accounts
  • Centers: Manage branch or center locations
  • Fixed Deposit Accounts: Handle fixed deposit account operations and lifecycle
  • Fixed Deposit Products: Manage fixed deposit product definitions and configurations
  • Recurring Deposit Accounts: Manage recurring deposit accounts and transactions

You will then debug the Apache Fineract pipeline using our Pipeline Dashboard tool to ensure it is copying the data correctly, before building a Notebook to explore your data and build reports.

Setup & steps to follow

💡

Before getting started, let's make sure Cursor is set up correctly:

Now you're ready to get started!

  1. ⚙️ Set up dlt Workspace

    Install dlt with duckdb support:

    pip install dlt[workspace]

    Initialize a dlt pipeline with Apache Fineract support.

    dlt init dlthub:apache_fineract duckdb

    The init command will setup the necessary files and folders for the next step.

  2. 🤠 Start LLM-assisted coding

    Here’s a prompt to get you started:

    Prompt
    Please generate a REST API Source for Apache Fineract API, as specified in @apache_fineract-docs.yaml Start with endpoint(s) accounts/share and provisioningcriteria and skip incremental loading for now. Place the code in apache_fineract_pipeline.py and name the pipeline apache_fineract_pipeline. If the file exists, use it as a starting point. Do not add or modify any other files. Use @dlt rest api as a tutorial. After adding the endpoints, allow the user to run the pipeline with python apache_fineract_pipeline.py and await further instructions.
  3. 🔒 Set up credentials

    Authentication uses HTTP Basic Auth with base64-encoded credentials passed as a query parameter. Send a POST request to self/authentication?username={username}&password={password} to obtain a base64EncodedAuthenticationKey. For subsequent requests, include the access token via the access_token query parameter in the URL (e.g., POST self/userdetails?access_token={base64EncodedAuthenticationKey}). The response includes user details, roles, permissions, and an authenticated boolean flag.

    To get the appropriate API keys, please visit the original source at demo.mifos.io. If you want to protect your environment secrets in a production environment, look into setting up credentials with dlt.

  4. 🏃‍♀️ Run the pipeline in the Python terminal in Cursor

    python apache_fineract_pipeline.py

    If your pipeline runs correctly, you’ll see something like the following:

    Pipeline apache_fineract load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset apache_fineract_data The duckdb destination used duckdb:/apache_fineract.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
  5. 📈 Debug your pipeline and data with the Pipeline Dashboard

    Now that you have a running pipeline, you need to make sure it’s correct, so you do not introduce silent failures like misconfigured pagination or incremental loading errors. By launching the dlt Workspace Pipeline Dashboard, you can see various information about the pipeline to enable you to test it. Here you can see:

    • Pipeline overview: State, load metrics
    • Data’s schema: tables, columns, types, hints
    • You can query the data itself
    dlt pipeline apache_fineract_pipeline show
  6. 🐍 Build a Notebook with data explorations and reports

    With the pipeline and data partially validated, you can continue with custom data explorations and reports. To get started, paste the snippet below into a new marimo Notebook and ask your LLM to go from there. Jupyter Notebooks and regular Python scripts are supported as well.

    import dlt data = dlt.pipeline("apache_fineract_pipeline").dataset() # get ["accounts/share"] table as Pandas frame data.["accounts/share"].df().head()

Extra resources:

Next steps