ToyBase


NameToyBase JSON
Version 1.0.3 PyPI version JSON
download
home_pagehttps://github.com/Sas2k/ToyBase
SummaryA Toy Database System written in Python
upload_time2022-12-09 09:37:24
maintainer
docs_urlNone
authorSasen Perera
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center">ToyBase 🚂</h3>

<div align="center">

[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/Sas2k/ToyBase.svg)](https://github.com/Sas2k/ToyBase/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/Sas2k/ToyBase.svg)](https://github.com/Sas2k/ToyBase/pulls)
[![Downloads](https://static.pepy.tech/personalized-badge/toybase?period=month&units=international_system&left_color=black&right_color=brightgreen&left_text=Downloads)](https://pepy.tech/project/toybase)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

</div>

<p align="center"> A Toy Database System written in Python
    <br> 
</p>

## 📝 Table of Contents

- [📝 Table of Contents](#-table-of-contents)
- [🧐 About ](#-about-)
- [🏁 Getting Started ](#-getting-started-)
  - [First off, Installing](#first-off-installing)
  - [And that's it basically...](#and-thats-it-basically)
- [🎈 Usage ](#-usage-)
- [⛏️ Built Using ](#️-built-using-)
- [✍️ Authors ](#️-authors-)

## 🧐 About <a name = "about"></a>

This is a simple Toy Database System written in Python. It's not meant to be used in production but you can use it in a small apps if ou want. This is meant as a learning tool for people who want to learn how databases work. it's fairly simple to learn and use.

## 🏁 Getting Started <a name = "getting_started"></a>

### First off, Installing

just use pip.

```bash
$ pip install ToyBase
```

### And that's it basically...

## 🎈 Usage <a name="usage"></a>

Creating a new table.

```python
from ToyBase import ToyBase

base = ToyBase.ToyBase("test")

base.create_table(["Name", "Phone"])
```

> This will create a new file called "test.tb" in the current directory.

Adding records/rows to the table.

```python
base.add_record(["John Doe", "123456789"])
```

> This will add a new record to the table.

Getting all records/rows from the table.

```python
base.show_records()
```

> This will return a list of all the records in the table.

Getting a specific record/row from the table.

```python
base.get_record(0)
```

> This will return the first record in the table.

Deleting a record/row from the table.

```python
base.delete_record(0)
```

> This will delete the first record in the table.


## ⛏️ Built Using <a name = "built_using"></a>

- [Python](https://www.python.org/) - Programming Language
- [Pickle](https://docs.python.org/3/library/pickle.html) - Python Object Serialization

## ✍️ Authors <a name = "authors"></a>

- [@Sas2k](https://github.com/Sas2k) - Idea & Initial work

See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Sas2k/ToyBase",
    "name": "ToyBase",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Sasen Perera",
    "author_email": "sas8.communications@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/bd/11/07c2f18202d5b945ae0ffd160748f9fdcc62c1962f529a041ea3f322efbc/ToyBase-1.0.3.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">ToyBase \ud83d\ude82</h3>\r\n\r\n<div align=\"center\">\r\n\r\n[![Status](https://img.shields.io/badge/status-active-success.svg)]()\r\n[![GitHub Issues](https://img.shields.io/github/issues/Sas2k/ToyBase.svg)](https://github.com/Sas2k/ToyBase/issues)\r\n[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/Sas2k/ToyBase.svg)](https://github.com/Sas2k/ToyBase/pulls)\r\n[![Downloads](https://static.pepy.tech/personalized-badge/toybase?period=month&units=international_system&left_color=black&right_color=brightgreen&left_text=Downloads)](https://pepy.tech/project/toybase)\r\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)\r\n\r\n</div>\r\n\r\n<p align=\"center\"> A Toy Database System written in Python\r\n    <br> \r\n</p>\r\n\r\n## \ud83d\udcdd Table of Contents\r\n\r\n- [\ud83d\udcdd Table of Contents](#-table-of-contents)\r\n- [\ud83e\uddd0 About ](#-about-)\r\n- [\ud83c\udfc1 Getting Started ](#-getting-started-)\r\n  - [First off, Installing](#first-off-installing)\r\n  - [And that's it basically...](#and-thats-it-basically)\r\n- [\ud83c\udf88 Usage ](#-usage-)\r\n- [\u26cf\ufe0f Built Using ](#\ufe0f-built-using-)\r\n- [\u270d\ufe0f Authors ](#\ufe0f-authors-)\r\n\r\n## \ud83e\uddd0 About <a name = \"about\"></a>\r\n\r\nThis is a simple Toy Database System written in Python. It's not meant to be used in production but you can use it in a small apps if ou want. This is meant as a learning tool for people who want to learn how databases work. it's fairly simple to learn and use.\r\n\r\n## \ud83c\udfc1 Getting Started <a name = \"getting_started\"></a>\r\n\r\n### First off, Installing\r\n\r\njust use pip.\r\n\r\n```bash\r\n$ pip install ToyBase\r\n```\r\n\r\n### And that's it basically...\r\n\r\n## \ud83c\udf88 Usage <a name=\"usage\"></a>\r\n\r\nCreating a new table.\r\n\r\n```python\r\nfrom ToyBase import ToyBase\r\n\r\nbase = ToyBase.ToyBase(\"test\")\r\n\r\nbase.create_table([\"Name\", \"Phone\"])\r\n```\r\n\r\n> This will create a new file called \"test.tb\" in the current directory.\r\n\r\nAdding records/rows to the table.\r\n\r\n```python\r\nbase.add_record([\"John Doe\", \"123456789\"])\r\n```\r\n\r\n> This will add a new record to the table.\r\n\r\nGetting all records/rows from the table.\r\n\r\n```python\r\nbase.show_records()\r\n```\r\n\r\n> This will return a list of all the records in the table.\r\n\r\nGetting a specific record/row from the table.\r\n\r\n```python\r\nbase.get_record(0)\r\n```\r\n\r\n> This will return the first record in the table.\r\n\r\nDeleting a record/row from the table.\r\n\r\n```python\r\nbase.delete_record(0)\r\n```\r\n\r\n> This will delete the first record in the table.\r\n\r\n\r\n## \u26cf\ufe0f Built Using <a name = \"built_using\"></a>\r\n\r\n- [Python](https://www.python.org/) - Programming Language\r\n- [Pickle](https://docs.python.org/3/library/pickle.html) - Python Object Serialization\r\n\r\n## \u270d\ufe0f Authors <a name = \"authors\"></a>\r\n\r\n- [@Sas2k](https://github.com/Sas2k) - Idea & Initial work\r\n\r\nSee also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project.\r\n\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A Toy Database System written in Python",
    "version": "1.0.3",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "0273878c6f97d0bd4405e1bbac9cd073",
                "sha256": "85716b6ab853256558a6baf559e649db9cb85e80ff195a671d5f41e10cd91218"
            },
            "downloads": -1,
            "filename": "ToyBase-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "0273878c6f97d0bd4405e1bbac9cd073",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3563,
            "upload_time": "2022-12-09T09:37:24",
            "upload_time_iso_8601": "2022-12-09T09:37:24.386797Z",
            "url": "https://files.pythonhosted.org/packages/bd/11/07c2f18202d5b945ae0ffd160748f9fdcc62c1962f529a041ea3f322efbc/ToyBase-1.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-09 09:37:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "Sas2k",
    "github_project": "ToyBase",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "toybase"
}
        
Elapsed time: 0.02085s