Metadata-Version: 2.4
Name: Zennix
Version: 0.1.0
Summary: Zennix: AI-powered automation for project documentation and scaffolding
Author-email: Gopal Goyal <goyal11.gopal@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/gopal-goyal/zennix
Project-URL: Repository, https://github.com/gopal-goyal/zennix
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.15.2
Requires-Dist: groq>=0.22.0
Dynamic: license-file

Here's a professional README.md for the Zennix library:

**Introduction**
---------------

Zennix is a Python library that utilizes Large Language Models (LLMs) to help developers quickly scaffold new projects. With Zennix, you can generate essential project files, including READMEs, requirements, and test stubs, in a matter of seconds.

**Features**
------------

* **Core Module**: Provides a set of functions to generate project scaffolding files, including READMEs, requirements, and test stubs.
* **CLI Module**: Offers a command-line interface to interact with Zennix, allowing you to quickly generate project scaffolding files.
* **LLM Module**: Utilizes Large Language Models to generate high-quality project scaffolding files, ensuring accuracy and consistency.

**Installation**
--------------

To install Zennix, run the following command:
```bash
pip install zennix
```
**Usage**
---------

To use Zennix, simply run the following command in your terminal:
```bash
zennix init <project_name>
```
Replace `<project_name>` with the desired name for your new project. Zennix will then generate the necessary project files and folders.

**CLI**
-----

The Zennix CLI provides a range of commands to help you manage your projects. Here are a few examples:

* `zennix init <project_name>`: Initializes a new project with the specified name.
* `zennix generate <file_type>`: Generates a specific type of file, such as a README or requirements file.
* `zennix test`: Runs a set of tests to ensure your project is properly configured.

**Contribution**
----------------

We welcome contributions to Zennix! If you'd like to contribute, please fork the repository and submit a pull request. You can also report any issues or bugs you encounter.

**License**
---------

Zennix is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

**Acknowledgments**
----------------

Zennix would not be possible without the contributions of the following individuals:

* Gopal Goyal

**Getting Started**
-------------------

To get started with Zennix, simply install the library and run the `zennix init` command. From there, you can use the CLI to generate project scaffolding files and manage your projects.

Happy coding!
