readme-updated

README.md

@@ -7,86 +7,12 @@
 * Easy connection to multiple data sources
 * Return Pandas DataFrame as the Output
 
-# Project Structure
-```plaintext
-dbsconnector/
-├── .github/
-│   └── workflows/
-│       └── ci.yaml
-│       └── python-publish.yaml
-├── src/
-│   └── dbsconnector/
-│       └── databases.py
-├── tests/
-│   ├── unit/
-│   │   └── test_unit.py
-│   └── integration/
-│       └── test_integration.py
-├── .gitignore
-├── LICENSE
-├── pyproject.toml
-├── README.md
-├── requirements_dev.txt
-├── requirements.txt
-├── setup.cfg
-├── setup.py
-├── template.py
-└── tox.ini
-```
-
-## requirements_dev.txt we use for the testing
-It makes it easier to install and manage dependencies for development and testing, separate from the dependencies required for production.
-
-## difference between requirements_dev.txt and requirements.txt
-requirements.txt is used to specify the dependencies required to run the production code of a Python project, while requirements_dev.txt is used to specify the dependencies required for development and testing purposes.
-
-## tox.ini
-We use if for the testing in the python package testing against different version of the python 
-
-### how tox works tox enviornment creation
-1. Install depedencies and packages 
-2. Run commands
-3. Its a combination of the (virtualenvwrapper and makefile)
-4. It creates a .tox
-
-## pyproject.toml
-it is being used for configuration the python project it is a alternative of the setup.cfg file. its containts configuration related to the build system
-such as the build tool used package name version author license and dependencies.
-
-## setup.cfg
-In summary, setup.cfg is used by setuptools to configure the packaging and installation of a Python projec
-
-## Testing python application
-*types of testing*
-1. Automated testing 
-2. Manual testing
-
-*Mode of testing*
-1. Unit testing
-2. Integration tests
-
-*Testing frameworks*
-1. pytest
-2. unittest
-3. robotframework
-4. selenium
-5. behave
-6. doctest
-
-## check with the code style formatting and syntax(coding standard)
-1. pylint
-2. flake8(it is best because it containt 3 library pylint pycodestyle mccabe)
-3. pycodestyle
-
-## CI/CD
- Implemented a robust CI/CD pipeline using GitHub Actions to automate testing, building, and deployment of this package to the PyPI repository. This ensures that every change is thoroughly tested and seamlessly deployed, maintaining the highest quality standards.
-
 # How to use this package?
 
 ## Installation
 To install the package, use pip:
 ```bash
-pip install dbsconnector==0.1
+pip install dbsconnector==0.2
 ```
 
 ## Usage
@@ -96,7 +22,7 @@ pip install dbsconnector==0.1
 # import the module:
 from dbsconnector import databases
 # load the data:
-df = databases.load_csv('sample.csv', ',')
+df = databases.load_csv(filepath='sample.csv', delimiter=',')
 # display the data:
 df
 ```
@@ -106,7 +32,7 @@ df
 # import the module:
 from dbsconnector import databases
 # load the data:
-df = databases.load_excelsheet('sample.xlsx', 'sample_sheet')
+df = databases.load_excelsheet(filepath='sample.xlsx', sheet_name='sample_sheet')
 # display the data:
 df
 ```
@@ -116,7 +42,7 @@ df
 # import the module:
 from dbsconnector import databases
 # load the data:
-df = databases.load_gsheet('17r9f4BL7sjmdLBnt92OdQP3CHK5bdT3hozg6DUJXGqU', 'sample_sheet')
+df = databases.load_gsheet(gsheet_id='17r9f4BL7sjmdLBnt92OdQP3CHK5bdT3hozg6DUJXGqU',sheet_name='sample_sheet')
 # display the data:
 df
 ```
@@ -126,7 +52,7 @@ df
 # import the module:
 from dbsconnector import databases
 # load the data:
-df = databases.load_mongodbdata('localhost', 'sample_database', 'sample_collection')
+df = databases.load_mongodbdata(host='localhost', database='sample_database', collection='sample_collection')
 # display the data:
 df
 ```