{"id":17749907,"url":"https://github.com/0nom4d/mdcreator","last_synced_at":"2026-02-24T09:05:09.350Z","repository":{"id":44997056,"uuid":"359567562","full_name":"0Nom4D/mdCreator","owner":"0Nom4D","description":"mdCreator creates a README.md file from command line and with a .json configuration file.","archived":false,"fork":false,"pushed_at":"2022-12-07T18:18:25.000Z","size":78,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-22T04:44:26.984Z","etag":null,"topics":["api","mermaidjs","pdoc3","python","readme","tenor"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0Nom4D.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-19T18:58:07.000Z","updated_at":"2022-11-17T15:15:58.000Z","dependencies_parsed_at":"2023-01-24T20:15:38.871Z","dependency_job_id":null,"html_url":"https://github.com/0Nom4D/mdCreator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/0Nom4D/mdCreator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0Nom4D%2FmdCreator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0Nom4D%2FmdCreator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0Nom4D%2FmdCreator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0Nom4D%2FmdCreator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0Nom4D","download_url":"https://codeload.github.com/0Nom4D/mdCreator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0Nom4D%2FmdCreator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29777632,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-24T04:54:30.205Z","status":"ssl_error","status_checked_at":"2026-02-24T04:53:58.628Z","response_time":75,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","mermaidjs","pdoc3","python","readme","tenor"],"created_at":"2024-10-26T11:41:48.734Z","updated_at":"2026-02-24T09:05:09.300Z","avatar_url":"https://github.com/0Nom4D.png","language":"Python","readme":"# mdCreator\n\nmdCreator is a Python project. mdCreator can create a README.md file using basic Python functionalities.\nmdCreator is connected to the Tenor API to get Gifs.\n\n## Before continuing\n\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=0Nom4D_mdCreator\u0026metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=0Nom4D_mdCreator) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=0Nom4D_mdCreator\u0026metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=0Nom4D_mdCreator) ![GitHub](https://img.shields.io/github/license/0Nom4D/mdCreator?style=flat-square) [![Documentation](https://img.shields.io/badge/Documentation-PDoc3-blue?style=flat-square)](https://0nom4d.github.io/mdCreator/)\n\nThis project is under the jurisdiction of the MIT License. Don't do dumb things.\n\n![Alt Text](https://media.tenor.com/images/4dc761d53f5bad9863d64de1e6cd8db4/tenor.gif)\n\nIn order to make mdCreator work from anywhere you can add it inside your $PATH environment variable:\n\n```text\n$\u003e export PATH=$PATH:path_to_mdCreator\n```\n\n### Prerequisites\n\nTo use this project, you'll need Python (Version 3.8):\n\n* [Python Installation](https://www.python.org/downloads/)\n\nPlease refer to this link in order to install `requests python 3 module` and `python-dotenv python 3 module`:\n\n* [Python Requests Module Installation](https://pypi.org/project/requests/)\n* [Python Python-Dotenv Module Installation](https://pypi.org/project/python-dotenv/)\n\n### Building program\n\nmdCreator is a little Python Script dedicated to help programmers to not spend 4 hours creating a README.md.\nCreated README.md is perfectly customisable using a .json configuration file.\n\nmdCreator use Tenor GIF Api. To use mdCreator, you will need a Tenor API Key. To get one, you can check\n[this](https://github.com/0Nom4D/mdCreator/wiki/API-Key-Registration).\n\nmdCreator works as it follows:\n\n```term\n$\u003e mdCreator --pname \u003cProject Name\u003e -l \u003cProject's Main Language\u003e\n```\n\nYou can have access to every option, you can use ```-h / --help``` option or read the table below.\n\n| Options                   | Action                                            |  Mandatory         |\n| ------------------------- |:-------------------------------------------------:|:------------------:|\n| -p / --pname Name         | Project Name                                      | \u0026#9745;            |\n| -l / --language Language  | Project's Main Language                           | \u0026#9745;            |\n| -a / --array              | Create a table in your README.md                  | \u0026#9744;            |\n| -g / --gif [Keywords ...] | Add Gifs corresponding to the keywords you give   | \u0026#9744;            |\n\nYou can also change the written categories by changing the mdCreator.json configuration file by adding / removing the categories.\nPlease use the following syntax while adding categories:\n\n```json lines\n{\n  \"student\": {\n    \"authors\": {\n      \"range\": 2,\n      \"title\": \"My new title\",\n      \"description\": \"My new description\"\n    },\n  }\n}\n\nwhere\n    range is the size of the title to add to the README (1 is the biggest and 3 is the smallest)\n```\n\n**For more information about configuration file, please check the [mdCreator wiki](https://github.com/0Nom4D/mdCreator/wiki/Configuration-File)!**\n\nYou now have the choice between a student configuration and a new professional configuration. Feel free to edit the 'pro' section inside the mdCreator.json configuration file.\n\n### Coding Style\n\nmdCreator is developed with Python. There's not a real coding style, but I tried being the cleaner possible.\n\n## Authors\n\n* **Arthur Adam** - [0Nom4D](https://github.com/0Nom4D)\n\n## Contributors\n\n[![Alt Text](https://contrib.rocks/image?repo=0Nom4D/mdCreator)](https://github.com/0Nom4D/mdCreator/graphs/contributors)\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0nom4d%2Fmdcreator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0nom4d%2Fmdcreator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0nom4d%2Fmdcreator/lists"}