SankeyExcelParser 1.0.0b0__py3-none-any.whl → 1.0.0b1__py3-none-any.whl

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 (26) hide show
  1. SankeyExcelParser/io_excel.py +26 -0
  2. SankeyExcelParser/io_excel_constants.py +28 -2
  3. SankeyExcelParser/sankey.py +25 -1
  4. SankeyExcelParser/sankey_utils/data.py +28 -3
  5. SankeyExcelParser/sankey_utils/excel_source.py +28 -2
  6. SankeyExcelParser/sankey_utils/flux.py +28 -2
  7. SankeyExcelParser/sankey_utils/functions.py +28 -2
  8. SankeyExcelParser/sankey_utils/node.py +28 -2
  9. SankeyExcelParser/sankey_utils/sankey_object.py +28 -2
  10. SankeyExcelParser/sankey_utils/table_object.py +28 -2
  11. SankeyExcelParser/sankey_utils/tag.py +28 -2
  12. SankeyExcelParser/sankey_utils/tag_group.py +28 -2
  13. SankeyExcelParser/su_trace.py +28 -0
  14. SankeyExcelParser/tests/integration/test_base.py +27 -2
  15. SankeyExcelParser/tests/integration/test_run_check_input.py +28 -2
  16. SankeyExcelParser/tests/integration/test_run_conversions.py +28 -2
  17. SankeyExcelParser/tests/integration/test_run_load_input.py +28 -2
  18. SankeyExcelParser-1.0.0b1.dist-info/LICENSE +21 -0
  19. SankeyExcelParser-1.0.0b1.dist-info/METADATA +44 -0
  20. SankeyExcelParser-1.0.0b1.dist-info/RECORD +33 -0
  21. SankeyExcelParser-1.0.0b0.dist-info/METADATA +0 -113
  22. SankeyExcelParser-1.0.0b0.dist-info/RECORD +0 -32
  23. {SankeyExcelParser-1.0.0b0.data → SankeyExcelParser-1.0.0b1.data}/scripts/run_parse_and_write_excel.py +0 -0
  24. {SankeyExcelParser-1.0.0b0.data → SankeyExcelParser-1.0.0b1.data}/scripts/run_parse_excel.py +0 -0
  25. {SankeyExcelParser-1.0.0b0.dist-info → SankeyExcelParser-1.0.0b1.dist-info}/WHEEL +0 -0
  26. {SankeyExcelParser-1.0.0b0.dist-info → SankeyExcelParser-1.0.0b1.dist-info}/top_level.txt +0 -0
@@ -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
@@ -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 description for ExcelSource class
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 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 -----------------------------------------------------
@@ -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
  # CLASS ----------------------------------------------------------------------------
@@ -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,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,44 @@
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
+ Requires-Dist: openpyxl
11
+ Requires-Dist: pandas
12
+ Requires-Dist: argparse
13
+ Requires-Dist: xmltodict
14
+ Requires-Dist: psutil
15
+ Requires-Dist: xlrd
16
+ Requires-Dist: numpy
17
+ Requires-Dist: seaborn
18
+ Requires-Dist: Unidecode
19
+ Requires-Dist: xlwings
20
+
21
+ # SankeyExcelParser
22
+
23
+ ## Description
24
+ 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.
25
+ There are two at this time:
26
+ - OpenSankey publicly available at https://gitlab.com/terriflux-public/OpenSankey
27
+ - SCMFA wich is a private application commercialized by TerriFlux (terriflux.fr) which is running on app.terriflux.fr
28
+
29
+ ## Installation
30
+
31
+ ### Executable
32
+ - Available on https://pypi.org/project/SankeyExcelParser/
33
+ - To install pip install SankeyExcelParser
34
+
35
+ ### Repository
36
+ - git clone https://gitlab.com/su-model/sankeyexcelparser.git SankeyExcelParser
37
+
38
+ ## Run it
39
+
40
+ ## Test it
41
+
42
+ ## Integrate with your tools
43
+
44
+ - To write
@@ -0,0 +1,33 @@
1
+ SankeyExcelParser/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ SankeyExcelParser/io_excel.py,sha256=ALceh-AyRQwRscjO8eDbtPEFLHEDFRz5ScphKkxl1p8,70079
3
+ SankeyExcelParser/io_excel_constants.py,sha256=U6ouFNpwK740g7dukQWH5rKjNp6VR_d3SOBUogEbA00,42951
4
+ SankeyExcelParser/sankey.py,sha256=dFoTaHLMXmQB0pKJBT0XuHQW_2OzsWuEV_MaLLduxhI,149072
5
+ SankeyExcelParser/su_trace.py,sha256=d-FQt7koghw_xqUzxpHwCV2wuWjF21yXp1Kg2ZUpbuk,8888
6
+ SankeyExcelParser/sankey_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
7
+ SankeyExcelParser/sankey_utils/data.py,sha256=Zu9fjmLkykxKWTneiBKlIuwag1d5pAT0yvIT7eSznVE,34898
8
+ SankeyExcelParser/sankey_utils/excel_source.py,sha256=R1dk-I_S0tu06JCxU8ZAnXrQQo-CKoa7kTdRsJM6Az0,2284
9
+ SankeyExcelParser/sankey_utils/flux.py,sha256=Thk6r7tz456WHAszT7I6ecX20vMWoryHEydbqkzS1mw,12757
10
+ SankeyExcelParser/sankey_utils/functions.py,sha256=tP7h3E-N6X4FwOSgWb90ExfU4azaGtwZgJzECsqx1zE,9725
11
+ SankeyExcelParser/sankey_utils/node.py,sha256=DQgfqing606AwScN2y9oVvLG-E7jafsWa8K3knk2v6w,14117
12
+ SankeyExcelParser/sankey_utils/sankey_object.py,sha256=TIv0zGllB-CcRCeYxD7hVTcdS9usPubGCGZ_Zzn8-WM,6770
13
+ SankeyExcelParser/sankey_utils/table_object.py,sha256=L2nqNLMyCyqU0eQZ4kxG7xgQ45XkRYBNfTv4qUYXi_Y,2554
14
+ SankeyExcelParser/sankey_utils/tag.py,sha256=ig5N9iQw1FNzQnO-OTCT_09NF8TlTM3Rg520C0HK09k,3830
15
+ SankeyExcelParser/sankey_utils/tag_group.py,sha256=eMm3fQS7poxkMRCV2VLh-NJIU_frluQ9i7tbc-G1Sfc,7935
16
+ SankeyExcelParser/sankey_utils/protos/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
17
+ SankeyExcelParser/sankey_utils/protos/flux.py,sha256=D03frKB2nb8OwtYTRxst6RF1YsSBrufxMHBS-zJXVrw,1993
18
+ SankeyExcelParser/sankey_utils/protos/node.py,sha256=NC466RLPNUb-biwLaOE2U1OJEXQMmRjCjpqdhdEwToA,11415
19
+ SankeyExcelParser/sankey_utils/protos/sankey_object.py,sha256=qPPXspwm5f0QZj104eR5Xk6wcSr8zDO2_oj-2ZvhbB4,3013
20
+ SankeyExcelParser/sankey_utils/protos/tag_group.py,sha256=n7WUVc5-U4VBsBOSHhOcvdPG7HcED7fxEyN0G2ZodsQ,2363
21
+ SankeyExcelParser/tests/integration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
22
+ SankeyExcelParser/tests/integration/test_base.py,sha256=TKncpupELUHLpadxhCPb-MNTdeRpmsxbUVcHNs5KFhA,15239
23
+ SankeyExcelParser/tests/integration/test_run_check_input.py,sha256=U503EkLIeTXfLhzAoMKQfhcQWbFiOPK3opoSOrZ64UU,4885
24
+ SankeyExcelParser/tests/integration/test_run_conversions.py,sha256=1JXOEOnIpjU_0kBohjw00sKrHQWWxCVdN0tazxSiq4A,4711
25
+ SankeyExcelParser/tests/integration/test_run_load_input.py,sha256=QWTbNekTy3IYPbSnMnEAAkBn5aV10n8HHmld-MzEg3s,4580
26
+ SankeyExcelParser/tests/unit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
27
+ SankeyExcelParser-1.0.0b1.data/scripts/run_parse_and_write_excel.py,sha256=HDlbN773XC9AK5xDHzlne6OMN-pPrpt9CZzIugCbHNs,5738
28
+ SankeyExcelParser-1.0.0b1.data/scripts/run_parse_excel.py,sha256=_mZladNQhBlTAu5t1oFgDGrkLGdXJbe0gAayHviCVkw,3827
29
+ SankeyExcelParser-1.0.0b1.dist-info/LICENSE,sha256=bhCR1m7vsbWxcGfqadUBqTsckVE35IZC0Q1pSD-hyks,1097
30
+ SankeyExcelParser-1.0.0b1.dist-info/METADATA,sha256=MDpnIDM7UluWUxIz4pNy05iizxRgObW87q7dQIcQDRI,1284
31
+ SankeyExcelParser-1.0.0b1.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
32
+ SankeyExcelParser-1.0.0b1.dist-info/top_level.txt,sha256=ozKJMRXOIMUv1gm8994j3HZuNCek48LAyPEzqeD9VJ8,18
33
+ SankeyExcelParser-1.0.0b1.dist-info/RECORD,,
@@ -1,113 +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
- Requires-Dist: openpyxl
10
- Requires-Dist: pandas
11
- Requires-Dist: argparse
12
- Requires-Dist: xmltodict
13
- Requires-Dist: psutil
14
- Requires-Dist: xlrd
15
- Requires-Dist: numpy
16
- Requires-Dist: seaborn
17
- Requires-Dist: Unidecode
18
- Requires-Dist: xlwings
19
-
20
- # SankeyExcelParser
21
-
22
-
23
-
24
- ## Getting started
25
-
26
- To make it easy for you to get started with GitLab, here's a list of recommended next steps.
27
-
28
- 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)!
29
-
30
- ## Add your files
31
-
32
- - [ ] [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
33
- - [ ] [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:
34
-
35
- ```
36
- cd existing_repo
37
- git remote add origin https://gitlab.com/su-model/sankeyexcelparser.git
38
- git branch -M main
39
- git push -uf origin main
40
- ```
41
-
42
- ## Integrate with your tools
43
-
44
- - [ ] [Set up project integrations](https://gitlab.com/su-model/sankeyexcelparser/-/settings/integrations)
45
-
46
- ## Collaborate with your team
47
-
48
- - [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
49
- - [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
50
- - [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
51
- - [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
52
- - [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
53
-
54
- ## Test and Deploy
55
-
56
- Use the built-in continuous integration in GitLab.
57
-
58
- - [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
59
- - [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
60
- - [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
61
- - [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
62
- - [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
63
-
64
- ***
65
-
66
- # Editing this README
67
-
68
- 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.
69
-
70
- ## Suggestions for a good README
71
- 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.
72
-
73
- ## Name
74
- Choose a self-explaining name for your project.
75
-
76
- ## Description
77
- 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.
78
-
79
- ## Badges
80
- 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.
81
-
82
- ## Visuals
83
- 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.
84
-
85
- ## Installation
86
- 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.
87
-
88
- ## Usage
89
- 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.
90
-
91
- ## Support
92
- 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.
93
-
94
- ## Roadmap
95
- If you have ideas for releases in the future, it is a good idea to list them in the README.
96
-
97
- ## Contributing
98
- State if you are open to contributions and what your requirements are for accepting them.
99
-
100
- 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.
101
-
102
- 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.
103
-
104
- ## Authors and acknowledgment
105
- Show your appreciation to those who have contributed to the project.
106
-
107
- ## License
108
- For open source projects, say how it is licensed.
109
-
110
- ## Project status
111
- 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.
112
-
113
-
@@ -1,32 +0,0 @@
1
- SankeyExcelParser/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
- SankeyExcelParser/io_excel.py,sha256=HREvHUW-A678Tke2vDSby_0vrt66uUmxJIBtTd1j2A8,68499
3
- SankeyExcelParser/io_excel_constants.py,sha256=ljgVXjEIUSghPjf2iamy4TJYdAZVgE_K3HZbDLwE6js,41371
4
- SankeyExcelParser/sankey.py,sha256=sc9hT4Ax_MlT_HT8oKSeb5E2jlbddm-Rf_XAKFGgnKA,147520
5
- SankeyExcelParser/su_trace.py,sha256=wtKQrgYtiLOOXyFIggj0kDYUsRRjkHUnSDUG9SIGK60,7298
6
- SankeyExcelParser/sankey_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
7
- SankeyExcelParser/sankey_utils/data.py,sha256=M2SoJ4w2SkPLoFZd8LiA26RAEvo0q50JwKSo_D4o7LY,33320
8
- SankeyExcelParser/sankey_utils/excel_source.py,sha256=kOEgRJyEP8frUB7R2w_07uAuD8lM8kk1z4zig9qHZ0A,704
9
- SankeyExcelParser/sankey_utils/flux.py,sha256=k8NTrPyTK2B7yAthJqPXrvLLvTGWoVyATxbHx-PGXro,11177
10
- SankeyExcelParser/sankey_utils/functions.py,sha256=RuHih_K4h6pF3prbpjcNcTK5SNL1hXQhnX3SiKV3dlo,8145
11
- SankeyExcelParser/sankey_utils/node.py,sha256=ZDcZ8gAw-BzMV3AxopOQfxZnNnZd3a1G6bPwjIGE-G0,12537
12
- SankeyExcelParser/sankey_utils/sankey_object.py,sha256=IFG5ELNZkQ2MG0laUgFFinwiE4wxaq0FkrlsHEDAvQU,5190
13
- SankeyExcelParser/sankey_utils/table_object.py,sha256=Nej8_iAQampneCfFtgqTazyyi8vPbTcqS2uNMyMX888,974
14
- SankeyExcelParser/sankey_utils/tag.py,sha256=5zLDoQrDcroEE4Pqb93EcX04BWeWZebPezKGjQHkLWo,2250
15
- SankeyExcelParser/sankey_utils/tag_group.py,sha256=QvUf_bZEcu6BvuFAQ2VzjPMWGmr2NN6iGtlmVRmkYV0,6355
16
- SankeyExcelParser/sankey_utils/protos/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
17
- SankeyExcelParser/sankey_utils/protos/flux.py,sha256=D03frKB2nb8OwtYTRxst6RF1YsSBrufxMHBS-zJXVrw,1993
18
- SankeyExcelParser/sankey_utils/protos/node.py,sha256=NC466RLPNUb-biwLaOE2U1OJEXQMmRjCjpqdhdEwToA,11415
19
- SankeyExcelParser/sankey_utils/protos/sankey_object.py,sha256=qPPXspwm5f0QZj104eR5Xk6wcSr8zDO2_oj-2ZvhbB4,3013
20
- SankeyExcelParser/sankey_utils/protos/tag_group.py,sha256=n7WUVc5-U4VBsBOSHhOcvdPG7HcED7fxEyN0G2ZodsQ,2363
21
- SankeyExcelParser/tests/integration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
22
- SankeyExcelParser/tests/integration/test_base.py,sha256=Lns7Zm9ohNNr1hdlhEdG4pYVSwT14QHpBVQpVmwF1gs,13661
23
- SankeyExcelParser/tests/integration/test_run_check_input.py,sha256=HPAr4LRKitYLr7RAmbKNrrcTQgSGOgioeHrLqUaFtkY,3305
24
- SankeyExcelParser/tests/integration/test_run_conversions.py,sha256=6dHsDl7GqM5_nqRZULyb96AU0_XUI_X-2ted5PPNDJI,3131
25
- SankeyExcelParser/tests/integration/test_run_load_input.py,sha256=pPJq7T9nxUIGD_Fd191xkoZJbcNN01wEou48Qdp8h1c,3000
26
- SankeyExcelParser/tests/unit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
27
- SankeyExcelParser-1.0.0b0.data/scripts/run_parse_and_write_excel.py,sha256=HDlbN773XC9AK5xDHzlne6OMN-pPrpt9CZzIugCbHNs,5738
28
- SankeyExcelParser-1.0.0b0.data/scripts/run_parse_excel.py,sha256=_mZladNQhBlTAu5t1oFgDGrkLGdXJbe0gAayHviCVkw,3827
29
- SankeyExcelParser-1.0.0b0.dist-info/METADATA,sha256=RoW_QkNUqM0vFI3gDo67dUi0DsRzrMdqeBJrDugRcXM,6833
30
- SankeyExcelParser-1.0.0b0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
31
- SankeyExcelParser-1.0.0b0.dist-info/top_level.txt,sha256=ozKJMRXOIMUv1gm8994j3HZuNCek48LAyPEzqeD9VJ8,18
32
- SankeyExcelParser-1.0.0b0.dist-info/RECORD,,