Package project pip (#2)

* Start the package management

* Create LICENSE

* Add the license

* Change version to rc

* typo

* Add entry point

* Refactor project repositories and remove travis

* RC2 and change path to main in python init

* Troubleshooting entrypoint

* Debug pyproject, change test directory name + doc

* Update main.py

Update help display to new usage

* Update README.md

install automatically dependencies with "pip install ."

* Set v1.0

---------

Co-authored-by: Diego <[email protected]>

.github/workflows/publish-pip.yml

@@ -0,0 +1,33 @@
+# This workflow will upload a Python Package using Twine when a release is created
+
+name: Build and Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -7,4 +7,5 @@ TESTCSV/
 TESTXLSX.xlsx
 export/
 export_csv/
-export_html/
+export_html/
+/dist

README.md

@@ -4,14 +4,9 @@ polyspace-report2excel is a python module which adds the possibility
 to read a polyspace report and export misra or run-time results in 
 an excel file for easier analyse.
 
-## Installation
-You need to install XlsxWriter, striprtf and html2text, you can use pip for that:
+## Package installation
 
-```
-pip install XlsxWriter
-pip install html2text
-pip install striprtf
-```
+`pip install polyspace-report2excel`
 
 ## Usage
 Export polyspace data in an HTML report or RTF report then run export-all.py, you can use `--help`. 
@@ -22,11 +17,26 @@ by adding `--poly14` argument.
 By default it export all tables to excel and generate one file per Polyspace chapter.
 Use arguments to filter what you need.
 
+:warning: by converting RTF file you must precise --runtime or --misra
+
+
+### Usage example with the pip package
+```
+p2e input.html output-folder/
+
+p2e input.rtf ouput-folder/ --runtime
+```
+
+### Usage example by cloning the repository
+If you don't want to install the package `polyspace-report2excel`, first install the dependencies.
+
+`pip install .`
+
+Then, you can run:
 ``` 
-python export-all.py input.html ouput-folder/
-# OR
-## WARNING, by converting RTF file you must precise --runtime or --misra
-python export-all.py input.rtf ouput-folder/ --runtime
+python main.py input.html ouput-folder/
+
+python main.py input.rtf ouput-folder/ --runtime
 ```
 ## Arguments
 - `--misra` will export misra report only.

pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+# https://pypi.org/project/polyspace-report2excel/
+name = "polyspace-report2excel"
+version = "1.0" 
+description = "read a polyspace report and export misra or run-time results"
+readme = "README.md"
+requires-python = ">=3"
+license = {file = "LICENSE"}
+keywords = ["polyspace", "report", "excel", "misra"]
+authors = [
+  {name = "CAT Lab", email = "[email protected]" }
+]
+maintainers = [
+  {name = "CAT Lab", email = "[email protected]" }
+]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Quality Assurance",
+  "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+  "Programming Language :: Python :: 3"
+]
+
+# https://packaging.python.org/discussions/install-requires-vs-requirements/
+dependencies = [
+  "XlsxWriter",
+  "html2text",
+  "striprtf"
+]
+
+[project.urls]
+"Homepage" = "https://github.com/cnescatlab/polyspace-report2excel"
+"Bug Reports" = "https://github.com/cnescatlab/polyspace-report2excel/issues"
+
+[project.scripts]
+p2e = "p2e:main"
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"

HTMLReader.py → src/p2e/HTMLReader.py

@@ -3,9 +3,6 @@
 """ Nom du module: HTMLReader
  Description: Ce module permet la lecture d'un HTML et l'extraction des
     tableaux qu'il contient.
- Version: 1
- Date: 9 avril 2019
- Auteur: Louis MARTIN
  Methodes et classes publiques:
         - HTMLReader
             __init__(filename, version=18)

RTFReader.py → src/p2e/RTFReader.py

@@ -3,17 +3,14 @@
 """ Nom du module: RTFReader
  Description: Ce module permet la lecture d'un RTF et l'extraction des
     tableaux qu'il contient.
- Version: 1
- Date: 9 avril 2019
- Auteur: Louis MARTIN
  Methodes et classes publiques:
         - HTMLReader
             __init__(filename, version=18)
             get_all_tables()
 """
 
 # __________________________ IMPORT __________________________
-import HTMLReader
+from p2e import HTMLReader
 from striprtf.striprtf import rtf_to_text
 
 # ________________________ CONSTANTES ________________________

src/p2e/__init__.py

@@ -0,0 +1,17 @@
+"""
+Modules:
+exportcsv:
+    write to csv file
+exportxlsx:
+    write to excel file
+HTMLReader:
+    read HTML file and extract arrays from it
+RTFReader:
+    read RTF file and extract arrays from it
+main:
+    entrypoint for using this module
+"""
+
+def main():
+    import p2e.main
+    p2e.main.main()

exportcsv.py → src/p2e/exportcsv.py

@@ -1,8 +1,5 @@
 """ Nom du module: exportcsv
  Description: Ce module permet l'ecriture vers un fichier csv.
- Version: 1
- Date: 9 avril 2019
- Auteur: Louis MARTIN
  Methodes et classes publiques:
         - exportxlsx
             __init__(filename)

exportxlsx.py → src/p2e/exportxlsx.py

@@ -1,8 +1,5 @@
 """ Nom du module: exportxlsx
  Description: Ce module permet l'ecriture vers un fichier excel.
- Version: 1
- Date: 9 avril 2019
- Auteur: Louis MARTIN
  Methodes et classes publiques:
         - exportxlsx
             __init__(filename)