Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 3.41 KB

ReadMe.md

File metadata and controls

79 lines (53 loc) · 3.41 KB

AlgoPy

GitHub Issues GitHub Tag GitHub Commit Activity GitHub Language Count GitHub Branch Check Runs GitHub Repo Size Maintainability

Overview

AlgoPy is a comprehensive collection of utilities designed to streamline various tasks in software development. It includes robust logging capabilities and efficient algorithms for sorting and searching data structures. Whether you're building applications or maintaining systems, AlgoPy offers tools to enhance productivity and reliability.

Features

  • Powerful logging system for tracking application events and errors.
  • Efficient sorting and searching algorithms for quick data manipulation.
  • Easy-to-use Library for rapid integration into projects.
  • Super robust easy to implement.

Getting Started

To get started with AlgoPy, follow these steps:

Prerequisites

Ensure you have Python installed on your system. AlgoPy supports Python versions 3.6 and above. You must have pip installed to install the required packages.

To install: pip install -r requirements.txt

Recommended Usage

To use AlgoPy in your project, you can import the desired package and class as follows:

from algopy import PACKAGE_YOU_WANT

PACKAGE_YOU_WANT.method_or_class_to_use()

And all you have to do is read the documentation on the Wiki. (WIP - Version 2.1.1)

The following packages are available in AlgoPy:

  • log for logging events and errors. Is a wrapper for colorlog.
  • sort for sorting data structures. Has many types of sorting algorithms and data structures.
  • search for searching data structures. Has many types of searching algorithms.
  • find for finding data in a different set of structures.
  • convert for converting numbers and sizes to different types (Like HEX to BIN and KB to MB etc.).
  • faker for generating fake data for testing purposes.

Prerequisites

Ensure you have Python installed on your system. AlgoPy supports Python versions 3.11 and above. You must have pip installed to install the required packages.

To install: pip install -r requirements.txt


Contributing

We welcome contributions from the community. If you'd like to contribute, please fork the repository, make your changes, and submit a pull request.

License

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