generate-readme

Name	generate-readme JSON
Version	0.1 JSON
	download
home_page	https://github.com/Navlos/Generate_Readme_cli.git
Summary	Generate a README.md file for your projects
upload_time	2023-05-06 03:21:49
maintainer
docs_url	None
author	Adetunji Adetayo
requires_python
license
keywords	readme python
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # generate_Readme
The readme_generator is a command-line interface (CLI) tool written in Python that generates a README.md file for your project. It automatically creates a well-formatted and structured README.md file based on the information you provide about your project. 


## Dependencies

Markdown
argparse

## Usage

 readme_generator.py [-h] --project-name PROJECT_NAME --description DESCRIPTION
                           --installation INSTALLATION --usage USAGE --contribution
                           CONTRIBUTION --contact CONTACT
                           
all arguments are required: --project-name, --description, --installation, --usage, --contribution, --contact

## Support
kindly consider starring the project 

## Screenshot
![image](https://github.com/Navlos/images/blob/ca0048c5cd255c530bdffba9c3479908c6b6ea6a/Screenshot%202023-05-05%20125117.jpg)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Navlos/Generate_Readme_cli.git",
    "name": "generate-readme",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "README,python",
    "author": "Adetunji Adetayo",
    "author_email": "<litcoderr@gmail.com>",
    "download_url": "",
    "platform": null,
    "description": "# generate_Readme\r\nThe readme_generator is a command-line interface (CLI) tool written in Python that generates a README.md file for your project. It automatically creates a well-formatted and structured README.md file based on the information you provide about your project. \r\n\r\n\r\n## Dependencies\r\n\r\nMarkdown\r\nargparse\r\n\r\n## Usage\r\n\r\n readme_generator.py [-h] --project-name PROJECT_NAME --description DESCRIPTION\r\n                           --installation INSTALLATION --usage USAGE --contribution\r\n                           CONTRIBUTION --contact CONTACT\r\n                           \r\nall arguments are required: --project-name, --description, --installation, --usage, --contribution, --contact\r\n\r\n## Support\r\nkindly consider starring the project \r\n\r\n## Screenshot\r\n![image](https://github.com/Navlos/images/blob/ca0048c5cd255c530bdffba9c3479908c6b6ea6a/Screenshot%202023-05-05%20125117.jpg)\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Generate a README.md file for your projects",
    "version": "0.1",
    "project_urls": {
        "Homepage": "https://github.com/Navlos/Generate_Readme_cli.git"
    },
    "split_keywords": [
        "readme",
        "python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "04e03721a47b6482e61ebc7d1cb943fcb1ac3f6f74f9eff181f1ac8add6f8920",
                "md5": "2763f782e6e301a1b236089a4d0184f5",
                "sha256": "d7d211536a08e6e35260a6d533e6cb2329eb5b3461f8151a01b7b4358d6d02c9"
            },
            "downloads": -1,
            "filename": "generate_readme-0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2763f782e6e301a1b236089a4d0184f5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 2573,
            "upload_time": "2023-05-06T03:21:49",
            "upload_time_iso_8601": "2023-05-06T03:21:49.923549Z",
            "url": "https://files.pythonhosted.org/packages/04/e0/3721a47b6482e61ebc7d1cb943fcb1ac3f6f74f9eff181f1ac8add6f8920/generate_readme-0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-06 03:21:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Navlos",
    "github_project": "Generate_Readme_cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "generate-readme"
}