Skip to content

A simple πŸ‘ and efficient πŸ’ͺ DataBase πŸ“š designed to store and use large amounts of data.

License

Notifications You must be signed in to change notification settings

Adwaith-Rajesh/onstro-db

Repository files navigation

Onstro DB

Azure DevOps builds GitHub

A simple, fast and strict DB designed to store and handle large amounts of data.

https://adwaith-rajesh.github.io/onstro-db/

πŸ”» Installation

pip install onstro-db

πŸ“š tl;dr

A simple code snippet on how to use OnstroDB

from onstrodb import OnstroDb

# define the schema for the DB
db_schema = {
    "name": {"type": "str", "required": True},
    "age": {"type": "int", "required": True},
    "place": {"type": "str", "default": "canada"}
}

# initialize the db
db = OnstroDb(db_name="test-db", schema=db_schema)

db.add([
    {"name": "adwaith", "age": 16},
    {"name": "fred", "age": 17, "place": "texas"}
])
db.commit()

❓ Why use it ?

We all know that Pandas is fast, but it's also really hard to learn for beginners. That's where OnstroDb comes into action. This DB allows you to perform CRUD operations on data, with the speed promised by Pandas. Without you having to know a single thing about pandas. The DB is also strict.,i.e once the schema and the types of the data are defined it cannot be modified. And it also comes with a CLI.

  • Click here to see the docs.

πŸ€” Why name it Onstro DB ?

Coz it's supposed to handle monstrous amount of data.

πŸ₯° Contributing.

Read the CONTRIBUTING.md for the code design style and linting preferences.

Once you've gone though follow theses steps.

  • Fork this repo.
  • Create a new branch from master. (Very important)
  • Make your required changes with good commit messages.
  • Write the test to make sure that your changes work.
  • Create a pull request.
  • Bug the maintainers until it get merged 😊.

πŸ™Š Have any issue or feature request.

Create an issue or join our Discord server Here.