From 46f2d4347b3303e962b7e316fc3e472279104c03 Mon Sep 17 00:00:00 2001 From: yuvaneshkm Date: Tue, 17 Sep 2024 23:04:24 +0530 Subject: [PATCH] readme-updated --- README.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index d81bca6..c60a877 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,28 @@ # Database Connector Package # Overview -**dbsconnector** is a Python package designed to simplify the process of connecting to different data sources like csv files, excel sheets, google sheets, MongoDB database etc. This package provides a streamlined API for loading the data from different sources and return as Pandas DataFrame for any kind of DataScience, DataAnalysis and MachineLearning purpose. +**dbsconnector** is a Python package designed to simplify data integration from various sources, including CSV, Excel, Google Sheets, and MongoDB. The package provides a unified interface to connect, load, and process data with minimal setup, making it easier for Developers and Data Scientists to work across multiple data formats. -# Features -* Easy connection to multiple data sources -* Return Pandas DataFrame as the Output +# Current Features: +- Connect to CSV files and load them into a Pandas DataFrame +- Handle Excel files with multiple sheets +- Fetch data from Google Sheets using an API key +- Interact with MongoDB collections -# How to use this package? +# Future Features (Upcoming): +- Support for more databases (SQL, NoSQL) +- Cloud storage integration (AWS S3, Google Cloud, etc.) +- API-based data sources -## Installation +# Installation To install the package, use pip: ```bash pip install dbsconnector==0.2 ``` -## Usage +# How to use this package? -### Connecting to csv +## Connecting to csv ```py # import the module: from dbsconnector import databases @@ -27,7 +32,7 @@ df = databases.load_csv(filepath='sample.csv', delimiter=',') df ``` -### Connecting to Excel +## Connecting to Excel ```py # import the module: from dbsconnector import databases @@ -37,7 +42,7 @@ df = databases.load_excelsheet(filepath='sample.xlsx', sheet_name='sample_sheet' df ``` -### Connecting to gsheet +## Connecting to gsheet ```py # import the module: from dbsconnector import databases @@ -47,7 +52,7 @@ df = databases.load_gsheet(gsheet_id='17r9f4BL7sjmdLBnt92OdQP3CHK5bdT3hozg6DUJXG df ``` -### Connecting to MongoDB +## Connecting to MongoDB ```py # import the module: from dbsconnector import databases @@ -57,9 +62,8 @@ df = databases.load_mongodbdata(host='localhost', database='sample_database', co df ``` -# Contributing -* Several other data sources are to be included in upcomming versions. -* Contributions are welcome! Please open an issue or submit a pull request on GitHub. +# Contributions +* Contributions are welcome! Please open an issue or submit a pull request on GitHub for adding new features, fixing bugs, or improving documentation. Open-source collaboration is highly encouraged! # License This project is licensed under the MIT License.