Skip to content

Latest commit

 

History

History
88 lines (51 loc) · 2.33 KB

README.md

File metadata and controls

88 lines (51 loc) · 2.33 KB

CogForge 🛠️

Python License: MIT Build Status

CogForge is a lightweight, local-module handler designed for Python developers. It allows you to seamlessly code or import standalone codes or modules, turning them into a structured local module management system. Built with security and error handling at its core, CogForge aims to minimize code-breaking errors through an innovative error code system, ensuring your development process is as smooth and efficient as possible.

Features 🌟

  • Local Module Management: Organize your Python codes and modules locally with an easy-to-use interface.
  • Error Handling System: Advanced error code system to help you quickly identify and resolve issues.
  • Security First: Designed with security in mind to protect your code during the module handling process.
  • Simplicity: Intuitive design for easy adoption and minimal learning curve.
  • Efficiency: Minimizes code-breaking errors, enhancing your coding efficiency.

Installation 💾

pip install cogforge

Quick Start 🚀

  1. Create a new module:

    from cogforge import Forge
    
    my_module = Forge(name="MyModule")
  2. Add code or import a module:

    my_module.add_code("def hello_world():\\n    print('Hello, World!')")

    or

    my_module.import_module('path/to/your/module')
  3. Compile your module:

    my_module.compile()
  4. Enjoy your structured local module! 🎉

Test Code

from CogForge import Cogs
from cogs import si

coghandler = Cogs()

# Example usage
coghandler.si.TestFunction("Hi")

With si being the cog/module in the Cogs folder.

Documentation 📚

For full documentation, including advanced features and guides, visit CogForge Documentation.

Contributing 🤝

We welcome contributions! See our CONTRIBUTING.md file for more details on how to get started.

License 📄

CogForge is released under the MIT License. See the LICENSE file for more details.

Support 🆘

If you encounter any problems or have suggestions, please file an issue on the GitHub repository.


Happy Coding! 🎈