SankeyExcelParser 1.0.0b0__tar.gz → 1.0.0b1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. SankeyExcelParser-1.0.0b1/LICENSE +21 -0
  2. SankeyExcelParser-1.0.0b1/PKG-INFO +34 -0
  3. SankeyExcelParser-1.0.0b1/README.md +24 -0
  4. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/io_excel.py +26 -0
  5. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/io_excel_constants.py +28 -2
  6. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey.py +25 -1
  7. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/data.py +28 -3
  8. SankeyExcelParser-1.0.0b1/SankeyExcelParser/sankey_utils/excel_source.py +57 -0
  9. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/flux.py +28 -2
  10. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/functions.py +28 -2
  11. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/node.py +28 -2
  12. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/sankey_object.py +28 -2
  13. SankeyExcelParser-1.0.0b1/SankeyExcelParser/sankey_utils/table_object.py +63 -0
  14. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/tag.py +28 -2
  15. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/tag_group.py +28 -2
  16. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/su_trace.py +28 -0
  17. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/tests/integration/test_base.py +27 -2
  18. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/tests/integration/test_run_check_input.py +28 -2
  19. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/tests/integration/test_run_conversions.py +28 -2
  20. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/tests/integration/test_run_load_input.py +28 -2
  21. SankeyExcelParser-1.0.0b1/SankeyExcelParser.egg-info/PKG-INFO +34 -0
  22. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser.egg-info/SOURCES.txt +1 -0
  23. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/setup.py +6 -2
  24. SankeyExcelParser-1.0.0b0/PKG-INFO +0 -103
  25. SankeyExcelParser-1.0.0b0/README.md +0 -94
  26. SankeyExcelParser-1.0.0b0/SankeyExcelParser/sankey_utils/excel_source.py +0 -31
  27. SankeyExcelParser-1.0.0b0/SankeyExcelParser/sankey_utils/table_object.py +0 -37
  28. SankeyExcelParser-1.0.0b0/SankeyExcelParser.egg-info/PKG-INFO +0 -103
  29. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/__init__.py +0 -0
  30. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/__init__.py +0 -0
  31. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/protos/__init__.py +0 -0
  32. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/protos/flux.py +0 -0
  33. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/protos/node.py +0 -0
  34. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/protos/sankey_object.py +0 -0
  35. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/sankey_utils/protos/tag_group.py +0 -0
  36. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/tests/integration/__init__.py +0 -0
  37. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser/tests/unit/__init__.py +0 -0
  38. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser.egg-info/dependency_links.txt +0 -0
  39. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser.egg-info/requires.txt +0 -0
  40. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/SankeyExcelParser.egg-info/top_level.txt +0 -0
  41. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/bin/run_parse_and_write_excel.py +0 -0
  42. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/bin/run_parse_excel.py +0 -0
  43. {SankeyExcelParser-1.0.0b0 → SankeyExcelParser-1.0.0b1}/setup.cfg +0 -0
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2025 TerriFlux
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,34 @@
1
+ Metadata-Version: 2.1
2
+ Name: SankeyExcelParser
3
+ Version: 1.0.0b1
4
+ Summary: Excel Parser for OpenSankey suite
5
+ Home-page: https://gitlab.com/terriflux-public/sankeyexcelparser
6
+ Author: TerriFlux
7
+ Author-email: julien.alapetite@terriflux.fr
8
+ Description-Content-Type: text/markdown
9
+ License-File: LICENSE
10
+
11
+ # SankeyExcelParser
12
+
13
+ ## Description
14
+ This package allows to parse excel file with a specific format (todo format link) and instantiate a class Sankey which can be used by other applications.
15
+ There are two at this time:
16
+ - OpenSankey publicly available at https://gitlab.com/terriflux-public/OpenSankey
17
+ - SCMFA wich is a private application commercialized by TerriFlux (terriflux.fr) which is running on app.terriflux.fr
18
+
19
+ ## Installation
20
+
21
+ ### Executable
22
+ - Available on https://pypi.org/project/SankeyExcelParser/
23
+ - To install pip install SankeyExcelParser
24
+
25
+ ### Repository
26
+ - git clone https://gitlab.com/su-model/sankeyexcelparser.git SankeyExcelParser
27
+
28
+ ## Run it
29
+
30
+ ## Test it
31
+
32
+ ## Integrate with your tools
33
+
34
+ - To write
@@ -0,0 +1,24 @@
1
+ # SankeyExcelParser
2
+
3
+ ## Description
4
+ This package allows to parse excel file with a specific format (todo format link) and instantiate a class Sankey which can be used by other applications.
5
+ There are two at this time:
6
+ - OpenSankey publicly available at https://gitlab.com/terriflux-public/OpenSankey
7
+ - SCMFA wich is a private application commercialized by TerriFlux (terriflux.fr) which is running on app.terriflux.fr
8
+
9
+ ## Installation
10
+
11
+ ### Executable
12
+ - Available on https://pypi.org/project/SankeyExcelParser/
13
+ - To install pip install SankeyExcelParser
14
+
15
+ ### Repository
16
+ - git clone https://gitlab.com/su-model/sankeyexcelparser.git SankeyExcelParser
17
+
18
+ ## Run it
19
+
20
+ ## Test it
21
+
22
+ ## Integrate with your tools
23
+
24
+ - To write
@@ -1,4 +1,30 @@
1
1
  """
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
2
28
  This module is dedicated to the conversion from outside format to internal json format.
3
29
  Outside formats may be: a workbook (excel), another json file, a database etc...
4
30
  Structure and specifications of internal json format are defined in this module. Internal
@@ -1,10 +1,36 @@
1
- '''
1
+ """
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
2
28
  Author : Vincent LE DOZE
3
29
  Date : 31/05/23
4
30
 
5
31
  This file contains all constants for excel parsing.
6
32
 
7
- '''
33
+ """
8
34
 
9
35
  # Variables globales ==========================================================================
10
36
  # Tags for nodes & links -----------------------------------------------
@@ -1,5 +1,29 @@
1
1
  """
2
- Auteur : Vincent LE DOZE
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
3
27
  Date : 21/04/23
4
28
  """
5
29
 
@@ -1,10 +1,35 @@
1
- """
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
2
28
  Author : Vincent LE DOZE
3
29
  Date : 31/05/23
4
30
 
5
31
  This file contains descriptions for Data class
6
-
7
- """
32
+ '''
8
33
 
9
34
  # Local modules -----------------------------------------------------
10
35
  from SankeyExcelParser.sankey_utils.sankey_object import SankeyObject
@@ -0,0 +1,57 @@
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
28
+ Author : Vincent LE DOZE
29
+ Date : 31/05/23
30
+
31
+ This file contains description for ExcelSource class
32
+
33
+ '''
34
+
35
+ # External libs ----------------------------------------------------------------
36
+ import pandas as pd
37
+
38
+
39
+ # CLASS ----------------------------------------------------------------------------
40
+ class ExcelSource(object):
41
+ user_sheet_name: str
42
+ sheet_type: str
43
+ _table: pd.DataFrame
44
+
45
+ def __init__(
46
+ self,
47
+ user_sheet_name: str,
48
+ sheet_type: str,
49
+ ):
50
+ self.user_sheet_name = user_sheet_name
51
+ self.sheet_type = sheet_type
52
+
53
+ def save_origin_table(
54
+ self,
55
+ table: pd.DataFrame
56
+ ):
57
+ self.table = table
@@ -1,10 +1,36 @@
1
- """
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
2
28
  Author : Vincent LE DOZE
3
29
  Date : 31/05/23
4
30
 
5
31
  This file contains descriptions for Flux class
6
32
 
7
- """
33
+ '''
8
34
 
9
35
  # Local modules -----------------------------------------------------
10
36
  from SankeyExcelParser.sankey_utils.protos.flux import _ProtoFlux
@@ -1,10 +1,36 @@
1
- """
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
2
28
  Author : Vincent LE DOZE
3
29
  Date : 31/05/23
4
30
 
5
31
  This file contains functions used in sankey_utils modules
6
32
 
7
- """
33
+ '''
8
34
 
9
35
  # External libs ----------------------------------------------------------------
10
36
  import pandas as pd
@@ -1,10 +1,36 @@
1
- """
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
2
28
  Author : Vincent LE DOZE
3
29
  Date : 31/05/23
4
30
 
5
31
  This file contains descriptions for Node class
6
32
 
7
- """
33
+ '''
8
34
 
9
35
  # Local modules -----------------------------------------------------
10
36
  from SankeyExcelParser.sankey_utils.protos.flux import _ProtoFlux
@@ -1,10 +1,36 @@
1
- """
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
2
28
  Author : Vincent LE DOZE
3
29
  Date : 31/05/23
4
30
 
5
31
  This file contains descriptions for sankey proto class
6
32
 
7
- """
33
+ '''
8
34
 
9
35
 
10
36
  # Local modules -----------------------------------------------------
@@ -0,0 +1,63 @@
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
28
+ Author : Vincent LE DOZE
29
+ Date : 31/05/23
30
+
31
+ This file contains descriptions for sankey proto class
32
+
33
+ '''
34
+
35
+
36
+ # CLASS ----------------------------------------------------------------------------
37
+ class TableObject(object):
38
+ """
39
+ Define an object that is created from given table
40
+
41
+ :param extra_infos: Extra infos related to the object.
42
+ :type extra_infos: dict {info_name: info_content}
43
+
44
+ :param excel_source: Source Excel data.
45
+ :type excel_source: ExcelSource
46
+ """
47
+ def __init__(self):
48
+ self._extra_infos = {}
49
+ self._excel_source = None
50
+
51
+ @property
52
+ def extra_infos(self):
53
+ return self._extra_infos
54
+
55
+ @property
56
+ def extra_infos_name(self):
57
+ return list(self._extra_infos.keys())
58
+
59
+ def add_extra_info(self, info_name, info_content):
60
+ self._extra_infos[info_name] = info_content
61
+
62
+ def add_extra_infos(self, info_dict):
63
+ self._extra_infos.update(info_dict)
@@ -1,10 +1,36 @@
1
- """
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
2
28
  Author : Vincent LE DOZE
3
29
  Date : 31/05/23
4
30
 
5
31
  This file contains descriptions for Tag class
6
32
 
7
- """
33
+ '''
8
34
 
9
35
 
10
36
  # Local modules -----------------------------------------------------
@@ -1,10 +1,36 @@
1
- """
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
2
28
  Author : Vincent LE DOZE
3
29
  Date : 31/05/23
4
30
 
5
31
  This file contains descriptions for Tag class
6
32
 
7
- """
33
+ '''
8
34
 
9
35
  # Local modules -----------------------------------------------------
10
36
  from SankeyExcelParser.sankey_utils.protos.tag_group import _ProtoTagGroup
@@ -1,3 +1,31 @@
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+ '''
28
+
1
29
  import os
2
30
  import time
3
31
  import logging
@@ -1,7 +1,32 @@
1
- """
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
2
27
  Auteur : Vincent LE DOZE
3
28
  Date : 07/12/23
4
- """
29
+ '''
5
30
 
6
31
  # External libs ---------------------------------------------------------------
7
32
  import unittest
@@ -1,7 +1,33 @@
1
- """
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
2
28
  Auteur : Vincent LE DOZE
3
29
  Date : 07/12/23
4
- """
30
+ '''
5
31
 
6
32
  # External libs ---------------------------------------------------------------
7
33
  import argparse
@@ -1,7 +1,33 @@
1
- """
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
2
28
  Auteur : Vincent LE DOZE
3
29
  Date : 07/12/23
4
- """
30
+ '''
5
31
 
6
32
  # External libs ---------------------------------------------------------------
7
33
  import argparse
@@ -1,7 +1,33 @@
1
- """
1
+ '''
2
+ ==================================================================================================
3
+ The MIT License (MIT)
4
+ ==================================================================================================
5
+ Copyright (c) 2025 TerriFlux
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+ ==================================================================================================
25
+ Author : Vincent LE DOZE & Vincent CLAVEL & Julien Alapetite for TerriFlux
26
+ ==================================================================================================
27
+
2
28
  Auteur : Vincent LE DOZE
3
29
  Date : 07/12/23
4
- """
30
+ '''
5
31
 
6
32
  # External libs ---------------------------------------------------------------
7
33
  import argparse
@@ -0,0 +1,34 @@
1
+ Metadata-Version: 2.1
2
+ Name: SankeyExcelParser
3
+ Version: 1.0.0b1
4
+ Summary: Excel Parser for OpenSankey suite
5
+ Home-page: https://gitlab.com/terriflux-public/sankeyexcelparser
6
+ Author: TerriFlux
7
+ Author-email: julien.alapetite@terriflux.fr
8
+ Description-Content-Type: text/markdown
9
+ License-File: LICENSE
10
+
11
+ # SankeyExcelParser
12
+
13
+ ## Description
14
+ This package allows to parse excel file with a specific format (todo format link) and instantiate a class Sankey which can be used by other applications.
15
+ There are two at this time:
16
+ - OpenSankey publicly available at https://gitlab.com/terriflux-public/OpenSankey
17
+ - SCMFA wich is a private application commercialized by TerriFlux (terriflux.fr) which is running on app.terriflux.fr
18
+
19
+ ## Installation
20
+
21
+ ### Executable
22
+ - Available on https://pypi.org/project/SankeyExcelParser/
23
+ - To install pip install SankeyExcelParser
24
+
25
+ ### Repository
26
+ - git clone https://gitlab.com/su-model/sankeyexcelparser.git SankeyExcelParser
27
+
28
+ ## Run it
29
+
30
+ ## Test it
31
+
32
+ ## Integrate with your tools
33
+
34
+ - To write
@@ -1,3 +1,4 @@
1
+ LICENSE
1
2
  README.md
2
3
  setup.cfg
3
4
  setup.py
@@ -93,9 +93,9 @@ class BDistWheelInfoPyCommand(wheel.bdist_wheel.bdist_wheel):
93
93
 
94
94
  setup(
95
95
  name='SankeyExcelParser',
96
- version='1.0.0b',
96
+ version='1.0.0b1',
97
97
  description='Excel Parser for OpenSankey suite',
98
- url='https://gitlab.com/su-model/sankeyexcelparser',
98
+ url='https://gitlab.com/terriflux-public/sankeyexcelparser',
99
99
  author='TerriFlux',
100
100
  author_email='julien.alapetite@terriflux.fr',
101
101
  test_suite='tests',
@@ -134,3 +134,7 @@ setup(
134
134
  # pip install readme_renderer
135
135
  # python setup.py check -r -s
136
136
  #
137
+
138
+ # git clean -d -x -f
139
+ # python setup.py sdist bdist_wheel
140
+ # python -m twine --repository pypi dist/*
@@ -1,103 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: SankeyExcelParser
3
- Version: 1.0.0b0
4
- Summary: Excel Parser for OpenSankey suite
5
- Home-page: https://gitlab.com/su-model/sankeyexcelparser
6
- Author: TerriFlux
7
- Author-email: julien.alapetite@terriflux.fr
8
- Description-Content-Type: text/markdown
9
-
10
- # SankeyExcelParser
11
-
12
-
13
-
14
- ## Getting started
15
-
16
- To make it easy for you to get started with GitLab, here's a list of recommended next steps.
17
-
18
- Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
19
-
20
- ## Add your files
21
-
22
- - [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
23
- - [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
24
-
25
- ```
26
- cd existing_repo
27
- git remote add origin https://gitlab.com/su-model/sankeyexcelparser.git
28
- git branch -M main
29
- git push -uf origin main
30
- ```
31
-
32
- ## Integrate with your tools
33
-
34
- - [ ] [Set up project integrations](https://gitlab.com/su-model/sankeyexcelparser/-/settings/integrations)
35
-
36
- ## Collaborate with your team
37
-
38
- - [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
39
- - [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
40
- - [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
41
- - [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
42
- - [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
43
-
44
- ## Test and Deploy
45
-
46
- Use the built-in continuous integration in GitLab.
47
-
48
- - [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
49
- - [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
50
- - [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
51
- - [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
52
- - [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
53
-
54
- ***
55
-
56
- # Editing this README
57
-
58
- When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
59
-
60
- ## Suggestions for a good README
61
- Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
62
-
63
- ## Name
64
- Choose a self-explaining name for your project.
65
-
66
- ## Description
67
- Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
68
-
69
- ## Badges
70
- On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
71
-
72
- ## Visuals
73
- Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
74
-
75
- ## Installation
76
- Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
77
-
78
- ## Usage
79
- Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
80
-
81
- ## Support
82
- Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
83
-
84
- ## Roadmap
85
- If you have ideas for releases in the future, it is a good idea to list them in the README.
86
-
87
- ## Contributing
88
- State if you are open to contributions and what your requirements are for accepting them.
89
-
90
- For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
91
-
92
- You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
93
-
94
- ## Authors and acknowledgment
95
- Show your appreciation to those who have contributed to the project.
96
-
97
- ## License
98
- For open source projects, say how it is licensed.
99
-
100
- ## Project status
101
- If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
102
-
103
-
@@ -1,94 +0,0 @@
1
- # SankeyExcelParser
2
-
3
-
4
-
5
- ## Getting started
6
-
7
- To make it easy for you to get started with GitLab, here's a list of recommended next steps.
8
-
9
- Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
10
-
11
- ## Add your files
12
-
13
- - [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
14
- - [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
15
-
16
- ```
17
- cd existing_repo
18
- git remote add origin https://gitlab.com/su-model/sankeyexcelparser.git
19
- git branch -M main
20
- git push -uf origin main
21
- ```
22
-
23
- ## Integrate with your tools
24
-
25
- - [ ] [Set up project integrations](https://gitlab.com/su-model/sankeyexcelparser/-/settings/integrations)
26
-
27
- ## Collaborate with your team
28
-
29
- - [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
30
- - [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
31
- - [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
32
- - [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
33
- - [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
34
-
35
- ## Test and Deploy
36
-
37
- Use the built-in continuous integration in GitLab.
38
-
39
- - [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
40
- - [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
41
- - [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
42
- - [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
43
- - [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
44
-
45
- ***
46
-
47
- # Editing this README
48
-
49
- When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
50
-
51
- ## Suggestions for a good README
52
- Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
53
-
54
- ## Name
55
- Choose a self-explaining name for your project.
56
-
57
- ## Description
58
- Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
59
-
60
- ## Badges
61
- On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
62
-
63
- ## Visuals
64
- Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
65
-
66
- ## Installation
67
- Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
68
-
69
- ## Usage
70
- Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
71
-
72
- ## Support
73
- Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
74
-
75
- ## Roadmap
76
- If you have ideas for releases in the future, it is a good idea to list them in the README.
77
-
78
- ## Contributing
79
- State if you are open to contributions and what your requirements are for accepting them.
80
-
81
- For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
82
-
83
- You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
84
-
85
- ## Authors and acknowledgment
86
- Show your appreciation to those who have contributed to the project.
87
-
88
- ## License
89
- For open source projects, say how it is licensed.
90
-
91
- ## Project status
92
- If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
93
-
94
-
@@ -1,31 +0,0 @@
1
- """
2
- Author : Vincent LE DOZE
3
- Date : 31/05/23
4
-
5
- This file contains description for ExcelSource class
6
-
7
- """
8
-
9
- # External libs ----------------------------------------------------------------
10
- import pandas as pd
11
-
12
-
13
- # CLASS ----------------------------------------------------------------------------
14
- class ExcelSource(object):
15
- user_sheet_name: str
16
- sheet_type: str
17
- _table: pd.DataFrame
18
-
19
- def __init__(
20
- self,
21
- user_sheet_name: str,
22
- sheet_type: str,
23
- ):
24
- self.user_sheet_name = user_sheet_name
25
- self.sheet_type = sheet_type
26
-
27
- def save_origin_table(
28
- self,
29
- table: pd.DataFrame
30
- ):
31
- self.table = table
@@ -1,37 +0,0 @@
1
- """
2
- Author : Vincent LE DOZE
3
- Date : 31/05/23
4
-
5
- This file contains descriptions for sankey proto class
6
-
7
- """
8
-
9
-
10
- # CLASS ----------------------------------------------------------------------------
11
- class TableObject(object):
12
- """
13
- Define an object that is created from given table
14
-
15
- :param extra_infos: Extra infos related to the object.
16
- :type extra_infos: dict {info_name: info_content}
17
-
18
- :param excel_source: Source Excel data.
19
- :type excel_source: ExcelSource
20
- """
21
- def __init__(self):
22
- self._extra_infos = {}
23
- self._excel_source = None
24
-
25
- @property
26
- def extra_infos(self):
27
- return self._extra_infos
28
-
29
- @property
30
- def extra_infos_name(self):
31
- return list(self._extra_infos.keys())
32
-
33
- def add_extra_info(self, info_name, info_content):
34
- self._extra_infos[info_name] = info_content
35
-
36
- def add_extra_infos(self, info_dict):
37
- self._extra_infos.update(info_dict)
@@ -1,103 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: SankeyExcelParser
3
- Version: 1.0.0b0
4
- Summary: Excel Parser for OpenSankey suite
5
- Home-page: https://gitlab.com/su-model/sankeyexcelparser
6
- Author: TerriFlux
7
- Author-email: julien.alapetite@terriflux.fr
8
- Description-Content-Type: text/markdown
9
-
10
- # SankeyExcelParser
11
-
12
-
13
-
14
- ## Getting started
15
-
16
- To make it easy for you to get started with GitLab, here's a list of recommended next steps.
17
-
18
- Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
19
-
20
- ## Add your files
21
-
22
- - [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
23
- - [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
24
-
25
- ```
26
- cd existing_repo
27
- git remote add origin https://gitlab.com/su-model/sankeyexcelparser.git
28
- git branch -M main
29
- git push -uf origin main
30
- ```
31
-
32
- ## Integrate with your tools
33
-
34
- - [ ] [Set up project integrations](https://gitlab.com/su-model/sankeyexcelparser/-/settings/integrations)
35
-
36
- ## Collaborate with your team
37
-
38
- - [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
39
- - [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
40
- - [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
41
- - [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
42
- - [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
43
-
44
- ## Test and Deploy
45
-
46
- Use the built-in continuous integration in GitLab.
47
-
48
- - [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
49
- - [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
50
- - [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
51
- - [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
52
- - [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
53
-
54
- ***
55
-
56
- # Editing this README
57
-
58
- When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
59
-
60
- ## Suggestions for a good README
61
- Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
62
-
63
- ## Name
64
- Choose a self-explaining name for your project.
65
-
66
- ## Description
67
- Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
68
-
69
- ## Badges
70
- On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
71
-
72
- ## Visuals
73
- Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
74
-
75
- ## Installation
76
- Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
77
-
78
- ## Usage
79
- Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
80
-
81
- ## Support
82
- Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
83
-
84
- ## Roadmap
85
- If you have ideas for releases in the future, it is a good idea to list them in the README.
86
-
87
- ## Contributing
88
- State if you are open to contributions and what your requirements are for accepting them.
89
-
90
- For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
91
-
92
- You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
93
-
94
- ## Authors and acknowledgment
95
- Show your appreciation to those who have contributed to the project.
96
-
97
- ## License
98
- For open source projects, say how it is licensed.
99
-
100
- ## Project status
101
- If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
102
-
103
-