# Reado: Your Automated README Generator
## Introduction
Reado is a compatible command-line interface (CLI) tool designed to streamline the creation of professional-grade README files. Tired of manually writing READMEs? Reado automates the process by analyzing your project's structure and content, generating a comprehensive and well-formatted README in seconds. Simply point Reado at your project, and it will handle the rest, ensuring your project is well-documented and easily understood by others. Reado leverages the power of the Google Gemini 1.5 Flash model to produce high-quality, informative README files.
## Installation
Installing Reado is simple and straightforward. Ensure you have Python 3 installed on your system. Then, use pip to install the package:
```bash
sudo pip install reado
```
This will install Reado and its dependencies. You'll then need to set your [Google Gemini API](https://aistudio.google.com/) key (see [Usage](#usage) for details).
## Usage
Reado offers a streamlined workflow to generate your README. Follow these steps:
1. **Set your API Key:** Before using Reado, you must set your Google Gemini API](https://aistudio.google.com/) key. This key grants Reado access to the Gemini 1.5 Flash model. Use the following command, replacing `<YOUR_Gemini_API>` with your actual API key:
```bash
reado set_api_key <YOUR_Gemini_API>
```
2. **Initialize the Project:** After setting your API key, initialize Reado within your project's root directory:
```bash
reado init
```
This command creates the necessary configuration files. After running this command, a file named `readme_config.json` with the following structure is generated:
```json
"description": "<Write a brief description of your project.>",
"usage_example": "First , Second , ...",
"installation": "ex: pip install <YOUR-PrOJECT-NAME> ",
"contributing": "",
"license": ""
```
**Completing this information is required to create a README.**
3. **Generate the README:** Finally, generate the README file:
```bash
reado generate
```
Reado will Extract your project's structure using [Nimblex](https://pypi.org/project/nimblex), identify key components, and generate a comprehensive README.md file in your project's root directory. Ensure that Google services are supported in your region for successful operation. Reado must be run from the root directory of your project.
## Contributing
i welcome contributions to Reado!
## License
Reado is licensed under the MIT License. See the [LICENSE](https://github.com/pezhvak98/Reado/blob/main/LICENSE) file for more details.
<br>
<font size="1">This README was made using READO</font>
Raw data
{
"_id": null,
"home_page": "https://github.com/pezhvak98/Reado",
"name": "Reado",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "CLI, project-structure, readme-generator",
"author": "Pezhvak",
"author_email": "m.8562.m@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8c/2e/24737056d92f4be3dd3077e6a0d208e063946f879cc7003849f986098534/reado-0.1.tar.gz",
"platform": null,
"description": "\n# Reado: Your Automated README Generator\n\n \n\n## Introduction\n\n \n\nReado is a compatible command-line interface (CLI) tool designed to streamline the creation of professional-grade README files. Tired of manually writing READMEs? Reado automates the process by analyzing your project's structure and content, generating a comprehensive and well-formatted README in seconds. Simply point Reado at your project, and it will handle the rest, ensuring your project is well-documented and easily understood by others. Reado leverages the power of the Google Gemini 1.5 Flash model to produce high-quality, informative README files.\n\n \n\n## Installation\n\n \n\nInstalling Reado is simple and straightforward. Ensure you have Python 3 installed on your system. Then, use pip to install the package:\n```bash\nsudo pip install reado\n``` \n\nThis will install Reado and its dependencies. You'll then need to set your [Google Gemini API](https://aistudio.google.com/) key (see [Usage](#usage) for details).\n\n \n\n## Usage\n\n \n\nReado offers a streamlined workflow to generate your README. Follow these steps:\n\n \n\n1. **Set your API Key:** Before using Reado, you must set your Google Gemini API](https://aistudio.google.com/) key. This key grants Reado access to the Gemini 1.5 Flash model. Use the following command, replacing `<YOUR_Gemini_API>` with your actual API key:\n```bash\nreado set_api_key <YOUR_Gemini_API>\n```\n2. **Initialize the Project:** After setting your API key, initialize Reado within your project's root directory:\n```bash\nreado init\n```\nThis command creates the necessary configuration files. After running this command, a file named `readme_config.json` with the following structure is generated:\n```json\n\"description\": \"<Write a brief description of your project.>\",\n\n\"usage_example\": \"First , Second , ...\",\n\n\"installation\": \"ex: pip install <YOUR-PrOJECT-NAME> \",\n\n\"contributing\": \"\",\n\n\"license\": \"\"\n\n```\n**Completing this information is required to create a README.**\n\n \n\n3. **Generate the README:** Finally, generate the README file:\n```bash\nreado generate\n```\n\n \n\nReado will Extract your project's structure using [Nimblex](https://pypi.org/project/nimblex), identify key components, and generate a comprehensive README.md file in your project's root directory. Ensure that Google services are supported in your region for successful operation. Reado must be run from the root directory of your project.\n\n\n## Contributing\ni welcome contributions to Reado! \n \n\n## License\n\nReado is licensed under the MIT License. See the [LICENSE](https://github.com/pezhvak98/Reado/blob/main/LICENSE) file for more details.\n\n \n \n\n<br>\n\n<font size=\"1\">This README was made using READO</font>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI tool to generate README files based on project structure and configuration",
"version": "0.1",
"project_urls": {
"Bug Reports": "https://github.com/pezhvak98/Reado/issues",
"Homepage": "https://github.com/pezhvak98/Reado",
"Source": "https://github.com/pezhvak98/Reado"
},
"split_keywords": [
"cli",
" project-structure",
" readme-generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5891dfa7a27e55387f734f2620e11bfa167feeea30e4990de600462722682cf4",
"md5": "6bfa31ac9209e4f753776137c869209e",
"sha256": "b826ff1e24aa2f54f5434e2298d09fe80073abe5d10fcaa120361cd39912cf3d"
},
"downloads": -1,
"filename": "Reado-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6bfa31ac9209e4f753776137c869209e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6096,
"upload_time": "2024-12-06T18:57:45",
"upload_time_iso_8601": "2024-12-06T18:57:45.132459Z",
"url": "https://files.pythonhosted.org/packages/58/91/dfa7a27e55387f734f2620e11bfa167feeea30e4990de600462722682cf4/Reado-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c2e24737056d92f4be3dd3077e6a0d208e063946f879cc7003849f986098534",
"md5": "85a992d1b19327eb855269d28240841d",
"sha256": "5354751488a224970e2b7ea1d851f10607813b63d68b7998987716e2ab59d8ab"
},
"downloads": -1,
"filename": "reado-0.1.tar.gz",
"has_sig": false,
"md5_digest": "85a992d1b19327eb855269d28240841d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5943,
"upload_time": "2024-12-06T18:57:47",
"upload_time_iso_8601": "2024-12-06T18:57:47.775826Z",
"url": "https://files.pythonhosted.org/packages/8c/2e/24737056d92f4be3dd3077e6a0d208e063946f879cc7003849f986098534/reado-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 18:57:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pezhvak98",
"github_project": "Reado",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": []
},
{
"name": "nimblex",
"specs": []
}
],
"lcname": "reado"
}
JSON
