QuikDB CLI - Python Version

Overview

QuikDB is a database leveraging blockchain technology for secure and efficient data management. This CLI tool, implemented in Python, provides commands for configuring, deploying, and managing QuikDB projects seamlessly.

Prerequisites

Ensure the following prerequisites are met:

• Python: Version 3.8 or later.
• Pip: Python's package manager.
• Git: For cloning repositories.

Installation

1. Install QuikDB CLI via pip:

   pip install quikdb_cli
   

Usage

After installation, you can use the CLI to manage QuikDB operations.

1. View CLI Help:

To see the available commands and options:

quikdb --help

2. Install QuikDB:

Checks if QuikDB is installed and installs it if necessary:

quikdb install

3. Configure QuikDB:

Add configuration entries dynamically:

quikdb config --username <USERNAME> --email <EMAIL> --identity <IDENTITY>

4. Other Commands:

Extend the CLI with additional subcommands, such as deploying projects, uploading files, and managing tokens.

Troubleshooting

Resolving "Command Not Found" Issues:

1. Verify Installation: Check if quikdb is installed:

   pip show quikdb
   

2. Ensure PATH is Updated: Make sure the directory for global Python packages is in your PATH. You can find the directory using:

   python -m site --user-base
   

   Add the bin subdirectory of the above path to your PATH environment variable.

3. Reinstall the Package: If the issue persists, try reinstalling QuikDB:

   pip uninstall quikdb
   pip install quikdb
   

Contributing

We welcome contributions to QuikDB CLI! To contribute:

1. Fork the repository and create a new branch.
2. Commit your changes and push them to your fork.
3. Submit a pull request describing your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

If you encounter issues or have questions, please open an issue on the GitHub repository or contact the maintainers directly.