This repository contains Real Time Data Ingestion Platform SDK functions and documentation. This README will be a developer guide to understand the repository.

​​Real Time Data Ingestion Platform (RTDIP) SDK is a software development kit built to easily access some of RTDIP's transformation functions.

The RTDIP SDK will give the end user the power to use some of the convenience methods for frequency conversions and resampling of Pi data all through a self-service platform. RTDIP is offering a flexible product with the ability to authenticate and connect to Databricks SQL Warehouses given the end users preferences. RTDIP have taken the initiative to cut out the middle man and instead wrap these commonly requested methods in a simple python module so that you can instead focus on the data.

See RTDIP Documentation for more information on how to use the SDK.

Branch	Status
main
develop
feature

The structure of this repository is shown below in the tree diagram.

├── .devcontainer
├── .github
│   ├── workflows
├── docs
│   ├── api
│   ├── assets
│   ├── blog
│   ├── getting-started
│   ├── images
│   ├── integration
│   ├── releases
│   ├── roadmap
│   ├── sdk
│   ├── index.md
├── src
│   ├── api
│   │   ├── assets
│   │   ├── auth
│   │   ├── FastAPIApp
│   │   ├── v1
│   ├── apps
│   │   ├── docs
│   ├── sdk
│   │   ├── python
│   │   │    ├── rtdip-sdk
│   │   │    │   ├── authentication
│   │   │    │   ├── functions
│   │   │    │   ├── odbc
├── tests
│   ├── api
│   │   ├── auth
│   │   ├── v1
│   ├── apps
│   │   ├── docs
│   ├── sdk
│   │   ├── python
│   │   │    ├── rtdip-sdk
│   │   │    │   ├── authentication
│   │   │    │   ├── functions
│   │   │    │   ├── odbc
├── CODE_OF_CONDUCT.md  
├── CODEOWNERS.md 
├── CONTRIBUTING.md
├── GOVERNANCE.md
├── LICENSE.md
├── RELEASE.md
├── SUPPORT.md
├── PYPI-README.md
├── environment.yml
├── mkdocs.yml
├── setup.py   
└── .gitignore

1. To get started with developing for this project, clone the repository.

    git clone https://github.com/rtdip/core.git

2. Open the respository in VS Code, Visual Studio or your preferered code editor.

3. Create a new environment using the following command:

    conda env create -f environment.yml

NOTE: You will need to have conda, python and pip installed to use the command above.

4. Activate your newly set up environment using the following command:

    conda activate rtdip-sdk

You are now ready to start developing your own functions. Please remember to follow RTDIP's development lifecycle to maintain clarity and efficiency for a fully robust self serving platform.

1. Develop

2. Write unit tests

3. Document

4. Publish

NOTE: Ensure you have read the Release Guidelines before publishing your code.

This project welcomes contributions and suggestions. If you have a suggestion that would make this better you can simply open an issue with a relevant title. Don't forget to give the project a star! Thanks again!

For more details on contributing to this repository, see the Contibuting Guide. Please read this projects Code of Conduct before contributing.

This repository has been configured with support documentation for Real Time Data Ingestion Platform (RTDIP) to make it easier to get started. RTDIP's documentation is created using mkdocs and is hosted on Github Pages.

• Documentation can be found on RTDIP Documentation

Distributed under the Apache License Version 2.0. See LICENSE.md for more information.

• For reference documentation, pre-requisites, getting started, tutorials and examples visit RTDIP Documentation.
• File an issue via Github Issues.
• Check previous questions and answers or ask new ones on our slack channel #real-time-data-ingestion-platform

• Chat with other community members by joining the #real-time-data-ingestion-platform Slack channel. Click here to join our slack community