Skip to content

Commit

Permalink
readme-updated
Browse files Browse the repository at this point in the history
  • Loading branch information
yuvaneshkm committed Sep 17, 2024
1 parent f2e4ba5 commit 46f2d43
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit 46f2d43

Please sign in to comment.