Merge pull request #81 from fga-eps-mds/pip_r1

refactor: altera setup.py e adiciona novo README. Pip pronto para a R1

src/README.md

@@ -2,59 +2,95 @@
 
 ### What's up everyone!
 
-ez-docs 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.
+ez-docs is a MVP (minimum viable product) Python project 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 ez-docs, 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.
 
+#### Realised features
+
+- [x] Generate doc's in .pdf [#20](https://github.com/fga-eps-mds/2022-2-ez-docs/issues/20)
+- [ ] e-mail generated doc's [#24](https://github.com/fga-eps-mds/2022-2-ez-docs/issues/24)
+- [x] Package pip installation [#30](https://github.com/fga-eps-mds/2022-2-ez-docs/issues/30)
+- [x] Argparse commands [#39](https://github.com/fga-eps-mds/2022-2-ez-docs/issues/39)
+- [x] Run package via CLI [#43](https://github.com/fga-eps-mds/2022-2-ez-docs/issues/43)
+
+#### Realised doc's
+
+- [x] Github Page [#31](https://github.com/fga-eps-mds/2022-2-ez-docs/issues/31)
+- [x] README [#32](https://github.com/fga-eps-mds/2022-2-ez-docs/issues/32)
+- [x] Product Backlog [#33](https://github.com/fga-eps-mds/2022-2-ez-docs/issues/33)
+- [x] about [#39](https://github.com/fga-eps-mds/2022-2-ez-docs/issues/39)
+- [x] architecture [#39](https://github.com/fga-eps-mds/2022-2-ez-docs/issues/39)
+- [x] help [#39](https://github.com/fga-eps-mds/2022-2-ez-docs/issues/39)
+- [x] list [#39](https://github.com/fga-eps-mds/2022-2-ez-docs/issues/39)
+
+#### Bugs
+
+* Semicolon separator on .csv files not working.
+* Format .xlsx
+* key_pattern optionality.
+* flag=1/flag=2 always generating .md files.
+
 ## 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).
+* You read the [project GitPage](https://fga-eps-mds.github.io/2022-2-ez-docs/index.html).
 
 
 ## Installation
 
 To install *ez-docs*, open an interactive shell and run:
 ```bash
-$ python<version> -m pip install ez-docs
+$ python3 -m pip install ez-docs
+```
+Then, to assure the faultless installation, run:
+```bash
+$ ez-docs --about
+```
+The terminal ought to print something like this:
+```
+=====About this project=====
+
+	This project was developed by Software Engineering students at the University of Brasilia - Campus Gama (UnB-FGA) - during the 2022.2 semester, in the course of Software Development Methods (SDM), under the guidance of prof. Dr. Carla Rocha Aguiar.
+    ...
 ```
 
 ## Using ez-docs
 
-To start using *ez-docs*, you'll need a markdown template, a database (.csv, .txt, xls) and a pattern of keys.
+To start using *ez-docs*, you'll need a markdown template, a database (.csv, .txt, .xls) and a pattern of keys.
+
+* directory_template: str - template.md
+
+   In your markdown template you must to indicate the fields that you want to replace for the values in database, with the following pattern of keys:  <<SAME_DATABASE_COLUMN_NAME>> 
+
+
+    ![Template file example](/docs/images/template.png "Template file example")
+
+* database: str - database.(csv, txt, xls)
+
+    ![Database file example](/docs/images/database.png "Database file example")
 
-* 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}.
+* file_name_pattern: str - parameter concerning the denominator key of the document name, which must follow the format {key_pattern}.
 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
-$ ez-docs <~/template.md> <~/database> <~/pattern_keys> --flag = 1 or 2
+$ ez-docs <~/template.md> <~/database.csv> <pattern_keys> --flag=1 or 2
 ```
 
+![](/docs/images/exampleofuse.gif)
+
 ## Special functionalities
 
 ez-docs has some in-line functionalities. To use it, type one of the commands below in your terminal:
@@ -80,7 +116,7 @@ $ ez-docs --list
 ```
 
 ## Getting involved
-1. Read the [CONTRIBUTING.md](docs/CONTRIBUTING.md) guide.
+1. Read the [CONTRIBUTING.md](https://github.com/fga-eps-mds/2022-2-ez-docs/blob/main/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"`
@@ -93,10 +129,11 @@ $ ez-docs --list
 This project is under license. See the [LICENSE](LICENSE) file for details.
 
 ---
-**_ez-docs Team_**  
+## So, take it easy, and use ez-docs to make your docs!
 
 #### Special thanks to:
 Dr. [Carla Rocha Aguiar](https://github.com/RochaCarla), our professor at the University of Brasília.
 
+**_ez-docs Team_**  
 
 *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*

src/setup.py

@@ -11,7 +11,7 @@
 cmds = ["cmd/*.txt"]
 setup(
         name ='ez_docs',
-        version ='0.1.1',
+        version ='1.0.0',
         author ='Bruno Ribeiro, Bruno Martins, Diógenes Dantas, Igor Penha, Lucas Gobbi e Rafael Nobre',
         author_email ='[email protected]',
         description ='Um pacote python de geração de documentos automáticos',