Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #10

Merged
merged 1 commit into from
Jan 14, 2024
Merged

Update README.md #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 20 additions & 35 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
# 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)
[![License: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat&logo=license)](https://github.com/NotShrirang/pydbops/blob/main/LICENSE)
[![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.<br>
<b>"pydbops"</b> now supports <a href="https://www.google.com/search?q=sqlite3+standard+procedure">stored procedures</a> which standard sqlite3 doesn't provide!
<br>
Expand Down Expand Up @@ -40,37 +53,9 @@ _(You will need to call openDatabase() method using db.)_
- <a href="https://github.com/NotShrirang/pydbops/releases/download/v0.0.1/pydbops-cli-installer-X86_64.exe">Download</a> Installer
- <a href="https://github.com/NotShrirang/pydbops/tree/main/pydbops-cli#pydbops-cli">Read about CLI</a>


## Methods in Database:

1. <code>openDatabase()</code> - Creates a database and returns a Database object.
2. <code>createTable()</code> - Creates table of given name.
3. <code>addColumn()</code> - Function for adding new column.
4. <code>addEntry()</code> - Function for inserting values in database.
5. <code>callProcedure()</code> - Calls procedure of given name.
6. <code>changeColumn()</code> - Function for chnaging column type.
7. <code>createProcedure()</code> - Creates procedure of given name.
8. <code>createView()</code> - Creates view of given name.
9. <code>databaseVersion()</code> - Returns sqlite3 version.
10. <code>dropColumn()</code> - Function for deleting column.
11. <code>dropTable()</code> - Function for deleting table.
12. <code>fetchInOrder()</code> - Function for fetching database entries in given order.
13. <code>getData()</code> - Function for getting all data.
14. <code>getFieldNames()</code> - Function for getting field names.
15. <code>getTable()</code> - Creates Table instance.
16. <code>intersection()</code> - Performs intersection and returns all distinct rows selected by query.
17. <code>join()</code> - Performs SQL Join on table specified.
18. <code>length()</code> - Returns length of database.
20. <code>minus()</code> - Fetches rows which are present in first query but absent in second.
21. <code>removeEntry()</code> - Function for removing records from database.
22. <code>schema()</code> - Function for fetching schema of table in database.
23. <code>searchEntry()</code> - Function for searching in database.
24. <code>tableNames()</code> - Function for retrieving tables in a database.
25. <code>union()</code> - Performs union and returns all distinct rows selected by query.
26. <code>updateEntry()</code> - 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!
Loading