# Orbit Database Shell - Introduction
#### Welcome to the Orbit Database Shell repository and documentation. All project documentation is included within this repository and consists of markdown files and comments within the code. These are presented in real time by the "ZeroDocs" Orbit application which renders this content to HTML.
This project is the command line shell for the NoSQL database that underpins the Orbit Framework. It performs in much the same way as the MySQL shell other than it works with Orbit Databases rather than MySQL databases. Maybe with a few other visualisation improvements.
<table><tr><td width="50%"><img width="100%" src="images/screenshot.png" /></td>
<td width="50%">
<h3 style="padding-left:1.4em">Features</h3>
* The ability to create and manage multiple databases
* Drill-down and testing facilities
* Examine data and database structures
* Import and export JSON data, import data directly from MySQL
* Grammar, colourisation and auto-complete for everything
* Operation timing and data size distribution analysis
* Detailed help system with examples
* It's all written in Python and it's <b>very</b> extensible
</td></tr></table>
### Installation
Start off by creating a virtual environment using the tool of your choosing (we currently use "pyenv") then (don't forget to activate the environment) do;
```bash
pip install orbit_database_shell
```
And to run the shell just do;
```bash
$ orbit_database_shell
.oooooo. .o8 o8o . oooooooooo. oooooooooo.
d8P' `Y8b "888 `"' .o8 `888' `Y8b `888' `Y8b
888 888 oooo d8b 888oooo. oooo .o888oo 888 888 888 888
888 888 `888""8P d88' `88b `888 888 888 888 888oooo888'
888 888 888 888 888 888 888 8888888 888 888 888 `88b
`88b d88' 888 888 888 888 888 . 888 d88' 888 .88P
`Y8bood8P' d888b `Y8bod8P' o888o "888" o888bood8P' o888bood8P'
Orbit Database Command Line Tool (c) Mad Penguin Consulting Ltd 2023
To get started try help register or help for all available commands
none>
```
And you're live ...
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/madpenguin/orbit-database-shell",
"name": "orbit-database-shell",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "database, shell",
"author": "Gareth Bult",
"author_email": "gareth@madpenguin.uk",
"download_url": "https://files.pythonhosted.org/packages/66/1a/58fcdc7bbf8d962ce5fbee8e05e0fa06d2d11bd3658d1beec02b6ac61916/orbit_database_shell-1.0.28.tar.gz",
"platform": null,
"description": "# Orbit Database Shell - Introduction\n\n#### Welcome to the Orbit Database Shell repository and documentation. All project documentation is included within this repository and consists of markdown files and comments within the code. These are presented in real time by the \"ZeroDocs\" Orbit application which renders this content to HTML.\n\nThis project is the command line shell for the NoSQL database that underpins the Orbit Framework. It performs in much the same way as the MySQL shell other than it works with Orbit Databases rather than MySQL databases. Maybe with a few other visualisation improvements.\n\n<table><tr><td width=\"50%\"><img width=\"100%\" src=\"images/screenshot.png\" /></td>\n<td width=\"50%\">\n<h3 style=\"padding-left:1.4em\">Features</h3>\n\n* The ability to create and manage multiple databases\n* Drill-down and testing facilities\n* Examine data and database structures\n* Import and export JSON data, import data directly from MySQL\n* Grammar, colourisation and auto-complete for everything\n* Operation timing and data size distribution analysis\n* Detailed help system with examples\n* It's all written in Python and it's <b>very</b> extensible\n\n</td></tr></table>\n\n### Installation\n\nStart off by creating a virtual environment using the tool of your choosing (we currently use \"pyenv\") then (don't forget to activate the environment) do;\n```bash\npip install orbit_database_shell\n```\nAnd to run the shell just do;\n\n```bash\n$ orbit_database_shell \n\n .oooooo. .o8 o8o . oooooooooo. oooooooooo.\n d8P' `Y8b \"888 `\"' .o8 `888' `Y8b `888' `Y8b\n888 888 oooo d8b 888oooo. oooo .o888oo 888 888 888 888\n888 888 `888\"\"8P d88' `88b `888 888 888 888 888oooo888'\n888 888 888 888 888 888 888 8888888 888 888 888 `88b\n`88b d88' 888 888 888 888 888 . 888 d88' 888 .88P\n `Y8bood8P' d888b `Y8bod8P' o888o \"888\" o888bood8P' o888bood8P'\n\n Orbit Database Command Line Tool (c) Mad Penguin Consulting Ltd 2023\n To get started try help register or help for all available commands\nnone> \n```\n\nAnd you're live ...",
"bugtrack_url": null,
"license": null,
"summary": "Orbit-DB Shell",
"version": "1.0.28",
"project_urls": {
"Bug Tracker": "https://gitlab.com/madpenguin/orbit-database-shell/-/issues",
"Documentation": "https://gitlab.com/madpenguin/orbit-database-shell",
"Homepage": "https://gitlab.com/madpenguin/orbit-database-shell",
"Repository": "https://gitlab.com/madpenguin/orbit-database-shell"
},
"split_keywords": [
"database",
" shell"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa37ec14606c1611c900c6b0ed0bed39437cda3452e5c81f27a71650dc3ab62f",
"md5": "462d6c4b35e79b6cc0ec4eed5e5f0f1a",
"sha256": "640385a2f748471541c49b33359436f41ae39427550cfcd2d0d5dbed5306be39"
},
"downloads": -1,
"filename": "orbit_database_shell-1.0.28-py3-none-any.whl",
"has_sig": false,
"md5_digest": "462d6c4b35e79b6cc0ec4eed5e5f0f1a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 25485,
"upload_time": "2024-05-15T16:11:48",
"upload_time_iso_8601": "2024-05-15T16:11:48.761010Z",
"url": "https://files.pythonhosted.org/packages/aa/37/ec14606c1611c900c6b0ed0bed39437cda3452e5c81f27a71650dc3ab62f/orbit_database_shell-1.0.28-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "661a58fcdc7bbf8d962ce5fbee8e05e0fa06d2d11bd3658d1beec02b6ac61916",
"md5": "56db3de1c2f9eb3ad67eb888e549f85a",
"sha256": "007a363cb7bd69ba4c625dab0ef549aa338ff80741d44d1f0d99662aa3fa89df"
},
"downloads": -1,
"filename": "orbit_database_shell-1.0.28.tar.gz",
"has_sig": false,
"md5_digest": "56db3de1c2f9eb3ad67eb888e549f85a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 21857,
"upload_time": "2024-05-15T16:11:49",
"upload_time_iso_8601": "2024-05-15T16:11:49.940578Z",
"url": "https://files.pythonhosted.org/packages/66/1a/58fcdc7bbf8d962ce5fbee8e05e0fa06d2d11bd3658d1beec02b6ac61916/orbit_database_shell-1.0.28.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-15 16:11:49",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "madpenguin",
"gitlab_project": "orbit-database-shell",
"lcname": "orbit-database-shell"
}
JSON