From e7b9a2072d981d030c72d9b40cc45e703fa8b987 Mon Sep 17 00:00:00 2001 From: Shrirang Mahajan <85283622+NotShrirang@users.noreply.github.com> Date: Sun, 14 Jan 2024 11:36:27 +0530 Subject: [PATCH] Update README.md --- README.md | 55 ++++++++++++++++++++----------------------------------- 1 file changed, 20 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 959e50c..ec70a0e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# pydbops +# pydbops - Relational Database Management System for Python Developers -[![v0.0.8](https://img.shields.io/badge/version-v0.1.2-red.svg?style=flat&logo=)](https://github.com/NotShrirang/pydbops) +[![v0.1.2](https://img.shields.io/badge/version-v0.1.2-red.svg?style=flat&logo=)](https://github.com/NotShrirang/pydbops) [![PyPI Latest Release](https://img.shields.io/pypi/v/pydbops.svg)](https://pypi.org/project/pydbops/) ![Tests](https://github.com/NotShrirang/pydbops/actions/workflows/test.yml/badge.svg) ![Python Package](https://github.com/NotShrirang/pydbops/actions/workflows/python-package.yml/badge.svg) @@ -8,6 +8,19 @@ [![Language: Python](https://img.shields.io/badge/language-python-blue.svg?style=flat&logo=python)](https://www.python.org/) [![Framework: sqlite3](https://img.shields.io/badge/interface-sqlite3-blue.svg?style=flat&logo=sqlite3)](https://docs.python.org/3/library/sqlite3.html#:~:text=SQLite%20is%20a%20C%20library,SQLite%20for%20internal%20data%20storage.) +## Overview + +**pydbops** is a robust Relational Database Management System (RDBMS) developed on top of SQLite databases. It provides a convenient Command-Line Interface (CLI) alongside a Python library to simplify database operations. This project aims to enhance the database management experience for Python developers, offering features such as support for stored procedures, which standard SQLite3 does not provide. + +## Features + +- Simplified database operations +- Support for [stored procedures](https://www.google.com/search?q=sqlite3+standard+procedure) +- Command-Line Interface (CLI) for additional convenience + +## Installation + +Install **pydbops** using PyPI with the following command: Library for simplifying database operations.
"pydbops" now supports stored procedures which standard sqlite3 doesn't provide!
@@ -40,37 +53,9 @@ _(You will need to call openDatabase() method using db.)_ - Download Installer - Read about CLI - -## Methods in Database: - -1. openDatabase() - Creates a database and returns a Database object. -2. createTable() - Creates table of given name. -3. addColumn() - Function for adding new column. -4. addEntry() - Function for inserting values in database. -5. callProcedure() - Calls procedure of given name. -6. changeColumn() - Function for chnaging column type. -7. createProcedure() - Creates procedure of given name. -8. createView() - Creates view of given name. -9. databaseVersion() - Returns sqlite3 version. -10. dropColumn() - Function for deleting column. -11. dropTable() - Function for deleting table. -12. fetchInOrder() - Function for fetching database entries in given order. -13. getData() - Function for getting all data. -14. getFieldNames() - Function for getting field names. -15. getTable() - Creates Table instance. -16. intersection() - Performs intersection and returns all distinct rows selected by query. -17. join() - Performs SQL Join on table specified. -18. length() - Returns length of database. -20. minus() - Fetches rows which are present in first query but absent in second. -21. removeEntry() - Function for removing records from database. -22. schema() - Function for fetching schema of table in database. -23. searchEntry() - Function for searching in database. -24. tableNames() - Function for retrieving tables in a database. -25. union() - Performs union and returns all distinct rows selected by query. -26. updateEntry() - Function for updating values in database. - -For printing data in database, you can use default print() method by passing Database object in it. - -## Requirements: +## Requirements - Python > 3.5 -- sqlite3 +- SQLite3 + +## License +This project is licensed under the MIT License. Feel free to explore and contribute to the development of pydbops!