minidevtools 0.0.1

A Swiss Army knife for developers

MiniDevTools

A Swiss Army Knife for Developers

MiniDevTools is a developer tools project designed to empower users to manage their data directly on their own computers without the need to share it with others. It offers a seamless experience for users to handle tasks easily, quickly, and offline.

Table of Contents

• Table of Contents
• Features
• Tools
  • 1. HashTool
• Installation
  • From PyPI
  • From Source
• Usage
  • 1. As a Package
  • 2. Command Line Interface (CLI)
  • 3. Graphical User Interface (GUI)
• Documentation
• License

Features

• Privacy-focused: With MiniDevTools, users can work with their data locally, ensuring their privacy and security are maintained at all times.

• Offline functionality: Whether you're in a remote location or experiencing internet connectivity issues, MiniDevTools ensures that you can continue your work without interruption.

• Open Source: MiniDevTools is open source, allowing you to inspect and modify the code according to your requirements, and contribute to its development.

• Cross-Platform Compatibility: Whether you're using Windows, macOS, or Linux, MiniDevTools works seamlessly across different operating systems.

• Efficiency: Perform tasks efficiently and effectively with MiniDevTools' intuitive interface and streamlined processes.

• Customizable: Tailor MiniDevTools to suit your specific needs with customizable options and settings.

• Developer-friendly: Built with developers in mind, MiniDevTools offers a range of features and functionalities to support your workflow.

• Flexible Usage: MiniDevTools provides versatile usage options, including a Command Line Interface (CLI), Graphical User Interface (GUI), and seamless Package Integration into Python projects.

Tools

1. HashTool

HashTool is a versatile tool that caters to the needs of developers, security professionals, and anyone who values data integrity and security. Whether you need to hash sensitive information or verify file authenticity, HashTool provides the tools you need to get the job done efficiently and securely.

Features:

• Hashing Text: HashTool allows you to hash text strings securely using various hashing algorithms such as MD5, SHA-1, SHA-256, and SHA-512.

• Hashing Files: With HashTool, you can generate hashes for files of any type and size. Simply provide the file path, and HashTool will compute the hash value for you.

• Multiple Hash Algorithms: HashTool supports a wide range of hash algorithms, giving you the flexibility to choose the one that suits your security requirements.

[!IMPORTANT] Please be aware that MiniDevTools is currently in the development phase. As such, tools will be added gradually over time to enhance functionality and usability. We appreciate your patience and understanding as we work to bring you the best possible experience.

Installation

From PyPI

To install MiniDevTools from PyPI, simply use the following command:

  pip install minidevtools

From Source

To install MiniDevTools from Source, follow these steps:

1. Clone the repository:

git clone https://github.com/odest/MiniDevTools.git

2. Navigate to the MiniDevTools directory:

cd MiniDevTools

3. Install the package with using pip:

pip install .

By following these steps, you will have successfully installed MiniDevTools and its dependencies.

Usage

MiniDevTools offers three options for usage:

1. As a Package

Integrate MiniDevTools into your own code or project as a package. Simply import it as follows:

from minidevtools import HashTool

# Hashing text
hash_text = HashTool.SHA256(text="Hello, world!")
print("Hashed text with SHA256:", hash_text)

# Hashing file
hash_file = HashTool.SHA256(file="image.png")
print("Hashed file with SHA256:", hash_file)

You can then use the functionalities provided by MiniDevTools within your codebase.

2. Command Line Interface (CLI)

Utilize MiniDevTools via the Command Line Interface (CLI) for quick and efficient tasks. Execute the CLI script as follows:

mdt

[!NOTE] See the Documentation for details.

This allows you to access MiniDevTools' features directly from the command line.

3. Graphical User Interface (GUI)

Experience MiniDevTools' capabilities through the Graphical User Interface (GUI) for a user-friendly interaction. Launch the GUI to access its functionalities effortlessly.

Here is a concept gui design:

[!NOTE] The GUI option is currently under development and will be available soon.

Choose the option that best suits your workflow and preferences to make the most out of MiniDevTools.

Documentation

This project's detailed documentation can be found on our documentation website. Here, you'll find comprehensive information about the project's architecture, usage instructions, API reference, and much more.

Please visit our documentation website to explore the complete documentation for this project.

License

• This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

MiniDevTools - Empowering Developers Evernwhere