Skip to content

Latest commit

 

History

History
118 lines (82 loc) · 7.74 KB

README.md

File metadata and controls

118 lines (82 loc) · 7.74 KB
Raw

Real Time Data Ingestion Platform (RTDIP)

rtdip

PyPI version Supported Python versions PyPI downloads OpenSSF Best Practices Code Style Black

Branch Workflow Status Code Coverage Vulnerabilities Bugs
main Main Coverage Vulnerabilities Bugs
develop Develop Coverage Vulnerabilities Bugs

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

What is RTDIP SDK?

​​Real Time Data Ingestion Platform (RTDIP) SDK is a python software development kit built to provide users, data scientists and developers with the ability to interact with components of the Real Time Data Ingestion Platform, including:

  • Building, Executing and Deploying Ingestion Pipelines
  • Execution of queries on RTDIP data
  • Authentication to securely interact with environments and data

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

Repository Guidelines

Folder Structure

Folder Name Description
.github/workflows yml files for Github Action workflows
.devcontainer Setup for VS Code Remote Containers and Github Spaces
docs Documentation in markdown, organised by subject name at folder level
src Main projects and all souce code, organised by language and sdk name
tests Test projects and unit tests, organised by language and sdk name

File Structure

File Name Description
mkdocs.yml yml file to host all documentation on mkdocs
setup.py Set up requirements for python package deployment
environment.yml yml file to create an environment with all the dependencies for developers
CODE_OF_CONDUCT code of conduct
CODEOWNERS codeowners
CONTRIBUTING.yml contributing
GOVERNANCE.yml governance
LICENSE.yml license
RELEASE.yml releases
SUPPORT.yml support
PYPI-README.yml PyPi read me documentation
README.yml RTDIP read me documentation
.gitignore Informs Git which files to ignore when committing your project to the GitHub repository

Developer Guide

Getting Started

  1. To get started with developing for this project, clone the repository.
    git clone https://github.com/rtdip/core.git

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

  2. 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.

  1. 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.

RTDIP Development Lifecycle

  1. Develop

  2. Write unit tests

  3. Document

  4. Publish

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

Contribution

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.

Documentation

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.

Licensing

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

Need help?

  • 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 #rtdip

Community