# mkdocs
### What's up everyone!
mkdocs is a MVP (minimum viable product) that were build for an SDM (Software Development Methods) class, with the aim of learn the goals of different approaches for creating software through agile practices.
So, we contribute to the Open Source community with mkdocs, which helps users to issue a wide range of certificates, declarations, resumes, receipts, slips, or whatever else the imagination allows through a database and a template in markdown format.
## Prerequisites
Before starting, make sure you've met the following requirements:
* You have installed the latest version of `<Python>`.
* You have a `<Windows / Linux / Mac>` machine.
* You read the [project GitPage](https://fga-eps-mds.github.io/2022-2-Squad07/index.html).
## Installation
To install *mkdocs*, open an interactive shell and run:
```bash
$ python<version> -m pip install mkdocs-s7
```
## Using mkdocs
To start using *mkdocs*, you'll need a markdown template, a database (.csv, .txt, xls) and a pattern of keys.
* directory_template: str - template folder .md
* key_name_file: str - parameter concerning the denominator key of the document name, which must follow the format {key_name}.
For example, for a template that has the keys "name" and "registration", the output could be "name_registration", generating the following results:
- Aaron_3141592653.pdf
- Barnardo_2718281828.pdf
- Caliban_4815162342.pdf
Valid separators: registration_name, registration-name, registration:name, registration name.
* key_value: dict - dictionary with all the keys and their respective values, already extracted from the module that handled
the data.
- Structure:
```python
{
"NAME": "Diomedes",
"CLASS": "Databases",
"DATE": "23 November 2022",
"TIN": "161.803.398-87",
"REGISTRATION": "1123581321"
}
```
Keys are arbitrary in nature, which means that their names, quantities, and repetitions are uncertain. All will be searched within the template: those found will be replaced by the corresponding value, and those that are not will be indicated in the terminal via warning.
* flag: int - optional parameter that defines the final output format.
- 1 (def.) - The doc will be converted to .pdf
- 2 - The doc will remain in .md
With that, you may open an interactive shell and run:
```bash
$ mkdocs-s7 <~/template.md> <~/database> <~/pattern_keys> --flag = 1 or 2
```
## Getting involved
1. Read the [CONTRIBUTING.md](docs/CONTRIBUTING.md) guide.
2. Fork this repository.
3. Create a branch on your local machine: `git checkout -b <branch_name>`.
4. Make your changes and confirm them following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/): `git commit -m "commit_message"`
5. Send to origin branch: `git push origin <branch_name> / <local>`
6. Create pull request through Github.
## Open source licensing info
This project is under license. See the [LICENSE](LICENSE) file for details.
---
**2022-2-Squad7**
#### Special thanks to:
Dr. [Carla Rocha Aguiar](https://github.com/RochaCarla), our professor at the University of Brasília.
*Created by [Bruno Ribeiro](https://github.com/BrunoRiibeiro), [Bruno Martins](https://github.com/gitbmvb), [Diógenes Dantas](https://github.com/diogjunior100), [Igor Penha](https://github.com/igorpenhaa), [Lucas Bergholz](https://github.com/LucasBergholz) and [Rafael Nobre](https://github.com/RafaelN0bre) in 2022*
Raw data
{
"_id": null,
"home_page": "https://github.com/fga-eps-mds/2022-2-Squad07",
"name": "mkdocs-te",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Pacote",
"author": "Bruno Martins, Rafael Nobre, Di\u00f3genes J\u00fanior, Bruno Ribeiro, Igor Penha",
"author_email": "diogjunior10071@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ac/07/54ede03f0a2c9893429fe2d21da83dec34d24b15a692be40d2cd9fee6159/mkdocs_te-0.0.1.tar.gz",
"platform": null,
"description": "# mkdocs\n\n### What's up everyone!\n\nmkdocs is a MVP (minimum viable product) that were build for an SDM (Software Development Methods) class, with the aim of learn the goals of different approaches for creating software through agile practices.\n\nSo, we contribute to the Open Source community with mkdocs, which helps users to issue a wide range of certificates, declarations, resumes, receipts, slips, or whatever else the imagination allows through a database and a template in markdown format.\n\n## Prerequisites\n\nBefore starting, make sure you've met the following requirements:\n* You have installed the latest version of `<Python>`.\n* You have a `<Windows / Linux / Mac>` machine.\n* You read the [project GitPage](https://fga-eps-mds.github.io/2022-2-Squad07/index.html).\n\n\n## Installation\n\nTo install *mkdocs*, open an interactive shell and run:\n```bash\n$ python<version> -m pip install mkdocs-s7\n```\n\n## Using mkdocs\n\nTo start using *mkdocs*, you'll need a markdown template, a database (.csv, .txt, xls) and a pattern of keys.\n\n* directory_template: str - template folder .md\n* key_name_file: str - parameter concerning the denominator key of the document name, which must follow the format {key_name}.\nFor example, for a template that has the keys \"name\" and \"registration\", the output could be \"name_registration\", generating the following results:\n - Aaron_3141592653.pdf\n - Barnardo_2718281828.pdf\n - Caliban_4815162342.pdf\n\n Valid separators: registration_name, registration-name, registration:name, registration name.\n* key_value: dict - dictionary with all the keys and their respective values, already extracted from the module that handled\n\tthe data.\n - Structure:\n ```python\n {\n \"NAME\": \"Diomedes\",\n \"CLASS\": \"Databases\",\n \"DATE\": \"23 November 2022\",\n \"TIN\": \"161.803.398-87\",\n \"REGISTRATION\": \"1123581321\"\n }\n ```\n Keys are arbitrary in nature, which means that their names, quantities, and repetitions are uncertain. All will be searched within the template: those found will be replaced by the corresponding value, and those that are not will be indicated in the terminal via warning.\n* flag: int - optional parameter that defines the final output format.\n - 1 (def.) - The doc will be converted to .pdf\n - 2 - The doc will remain in .md\n\nWith that, you may open an interactive shell and run:\n```bash\n$ mkdocs-s7 <~/template.md> <~/database> <~/pattern_keys> --flag = 1 or 2\n```\n\n\n## Getting involved\n1. Read the [CONTRIBUTING.md](docs/CONTRIBUTING.md) guide.\n2. Fork this repository.\n3. Create a branch on your local machine: `git checkout -b <branch_name>`.\n4. Make your changes and confirm them following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/): `git commit -m \"commit_message\"`\n5. Send to origin branch: `git push origin <branch_name> / <local>`\n6. Create pull request through Github.\n\n\n## Open source licensing info\n\nThis project is under license. See the [LICENSE](LICENSE) file for details.\n\n---\n**2022-2-Squad7** \n\n#### Special thanks to:\nDr. [Carla Rocha Aguiar](https://github.com/RochaCarla), our professor at the University of Bras\u00edlia.\n\n\n*Created by [Bruno Ribeiro](https://github.com/BrunoRiibeiro), [Bruno Martins](https://github.com/gitbmvb), [Di\u00f3genes Dantas](https://github.com/diogjunior100), [Igor Penha](https://github.com/igorpenhaa), [Lucas Bergholz](https://github.com/LucasBergholz) and [Rafael Nobre](https://github.com/RafaelN0bre) in 2022*\n\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "",
"version": "0.0.1",
"split_keywords": [
"pacote"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "90e3608ad734c46a184366b3b5ca88a0",
"sha256": "6e1c81b252d52f9170da8b007f447635b2af5f58892986266e28eb606d154f6d"
},
"downloads": -1,
"filename": "mkdocs_te-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "90e3608ad734c46a184366b3b5ca88a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5544,
"upload_time": "2022-12-08T02:29:51",
"upload_time_iso_8601": "2022-12-08T02:29:51.345107Z",
"url": "https://files.pythonhosted.org/packages/ac/07/54ede03f0a2c9893429fe2d21da83dec34d24b15a692be40d2cd9fee6159/mkdocs_te-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-08 02:29:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "fga-eps-mds",
"github_project": "2022-2-Squad07",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "mdpdf",
"specs": [
[
"==",
"0.0.18"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"1.5.2"
]
]
}
],
"lcname": "mkdocs-te"
}
JSON
