Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0nom4d/mdcreator
mdCreator creates a README.md file from command line and with a .json configuration file.
https://github.com/0nom4d/mdcreator
api mermaidjs pdoc3 python readme tenor
Last synced: about 2 months ago
JSON representation
mdCreator creates a README.md file from command line and with a .json configuration file.
- Host: GitHub
- URL: https://github.com/0nom4d/mdcreator
- Owner: 0Nom4D
- License: mit
- Created: 2021-04-19T18:58:07.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T18:18:25.000Z (about 2 years ago)
- Last Synced: 2023-03-04T01:41:32.015Z (almost 2 years ago)
- Topics: api, mermaidjs, pdoc3, python, readme, tenor
- Language: Python
- Homepage:
- Size: 76.2 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mdCreator
mdCreator is a Python project. mdCreator can create a README.md file using basic Python functionalities.
mdCreator is connected to the Tenor API to get Gifs.
## Before continuing
[](https://sonarcloud.io/summary/new_code?id=0Nom4D_mdCreator) [](https://sonarcloud.io/summary/new_code?id=0Nom4D_mdCreator)  [](https://0nom4d.github.io/mdCreator/)
This project is under the jurisdiction of the MIT License. Don't do dumb things.
In order to make mdCreator work from anywhere you can add it inside your $PATH environment variable:
```text
$> export PATH=$PATH:path_to_mdCreator
```
### Prerequisites
To use this project, you'll need Python (Version 3.8):
* [Python Installation](https://www.python.org/downloads/)
Please refer to this link in order to install `requests python 3 module` and `python-dotenv python 3 module`:
* [Python Requests Module Installation](https://pypi.org/project/requests/)
* [Python Python-Dotenv Module Installation](https://pypi.org/project/python-dotenv/)
### Building program
mdCreator is a little Python Script dedicated to help programmers to not spend 4 hours creating a README.md.
Created README.md is perfectly customisable using a .json configuration file.
mdCreator use Tenor GIF Api. To use mdCreator, you will need a Tenor API Key. To get one, you can check
[this](https://github.com/0Nom4D/mdCreator/wiki/API-Key-Registration).
mdCreator works as it follows:
```term
$> mdCreator --pname -l
```
You can have access to every option, you can use ```-h / --help``` option or read the table below.
| Options | Action | Mandatory |
| ------------------------- |:-------------------------------------------------:|:------------------:|
| -p / --pname Name | Project Name | ☑ |
| -l / --language Language | Project's Main Language | ☑ |
| -a / --array | Create a table in your README.md | ☐ |
| -g / --gif [Keywords ...] | Add Gifs corresponding to the keywords you give | ☐ |
You can also change the written categories by changing the mdCreator.json configuration file by adding / removing the categories.
Please use the following syntax while adding categories:
```json lines
{
"student": {
"authors": {
"range": 2,
"title": "My new title",
"description": "My new description"
},
}
}
where
range is the size of the title to add to the README (1 is the biggest and 3 is the smallest)
```
**For more information about configuration file, please check the [mdCreator wiki](https://github.com/0Nom4D/mdCreator/wiki/Configuration-File)!**
You 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.
### Coding Style
mdCreator is developed with Python. There's not a real coding style, but I tried being the cleaner possible.
## Authors
* **Arthur Adam** - [0Nom4D](https://github.com/0Nom4D)
## Contributors
[](https://github.com/0Nom4D/mdCreator/graphs/contributors)