# README Generator
A simple Python package to generate README files for projects automatically.
## Features
- Automatically generates README files with customizable content.
## Installation
```bash
pip install readme_gen
```
## Usage
```python
from readme_gen import generate_readme
generate_readme(
project_name="My Awesome Project",
description="This project is awesome because...",
installation_instructions="pip install -r requirements.txt",
usage_instructions="python main.py",
license_info="MIT License"
)
```
## License
MIT License
Raw data
{
"_id": null,
"home_page": "https://github.com/Eshaniqbal/Readme_gen-Package",
"name": "readme-gen",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Eshan Iqbal",
"author_email": "mireshan321@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7b/2a/ee9e42c89c175f3e394975e3bab401d953dd2fc306e15b5c3d7cde5a8a71/readme_gen-0.1.tar.gz",
"platform": null,
"description": "# README Generator\r\n\r\nA simple Python package to generate README files for projects automatically.\r\n\r\n## Features\r\n\r\n- Automatically generates README files with customizable content.\r\n\r\n## Installation\r\n\r\n```bash\r\npip install readme_gen\r\n```\r\n\r\n## Usage\r\n\r\n```python\r\nfrom readme_gen import generate_readme\r\n\r\ngenerate_readme(\r\n project_name=\"My Awesome Project\",\r\n description=\"This project is awesome because...\",\r\n installation_instructions=\"pip install -r requirements.txt\",\r\n usage_instructions=\"python main.py\",\r\n license_info=\"MIT License\"\r\n)\r\n```\r\n\r\n## License\r\n\r\nMIT License\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple package to generate README files for projects automatically.",
"version": "0.1",
"project_urls": {
"Homepage": "https://github.com/Eshaniqbal/Readme_gen-Package"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c8d7e4ddf1bc9faf4846c848692774963a7ff7a7af3e2f3050bdae58af1d77a",
"md5": "785361235df500f7af14dca778c38be5",
"sha256": "4f67e4617766d30b7cc64d6b2469890b655629af1a2118cdfcf5dab064d66606"
},
"downloads": -1,
"filename": "readme_gen-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "785361235df500f7af14dca778c38be5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2068,
"upload_time": "2024-08-29T05:49:27",
"upload_time_iso_8601": "2024-08-29T05:49:27.503146Z",
"url": "https://files.pythonhosted.org/packages/5c/8d/7e4ddf1bc9faf4846c848692774963a7ff7a7af3e2f3050bdae58af1d77a/readme_gen-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7b2aee9e42c89c175f3e394975e3bab401d953dd2fc306e15b5c3d7cde5a8a71",
"md5": "6cc8f16d2d2ba08c3b3363e980ec2023",
"sha256": "921bd701e6e615a25d8b90c53c54a1bc1d82ef002fa9c7c2cba647040d3c26c5"
},
"downloads": -1,
"filename": "readme_gen-0.1.tar.gz",
"has_sig": false,
"md5_digest": "6cc8f16d2d2ba08c3b3363e980ec2023",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1751,
"upload_time": "2024-08-29T05:49:29",
"upload_time_iso_8601": "2024-08-29T05:49:29.423676Z",
"url": "https://files.pythonhosted.org/packages/7b/2a/ee9e42c89c175f3e394975e3bab401d953dd2fc306e15b5c3d7cde5a8a71/readme_gen-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-29 05:49:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Eshaniqbal",
"github_project": "Readme_gen-Package",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "readme-gen"
}
JSON
