SankeyExcelParser 1.0.0b0__py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (32) hide show
  1. SankeyExcelParser/__init__.py +0 -0
  2. SankeyExcelParser/io_excel.py +1867 -0
  3. SankeyExcelParser/io_excel_constants.py +811 -0
  4. SankeyExcelParser/sankey.py +3138 -0
  5. SankeyExcelParser/sankey_utils/__init__.py +0 -0
  6. SankeyExcelParser/sankey_utils/data.py +1118 -0
  7. SankeyExcelParser/sankey_utils/excel_source.py +31 -0
  8. SankeyExcelParser/sankey_utils/flux.py +344 -0
  9. SankeyExcelParser/sankey_utils/functions.py +278 -0
  10. SankeyExcelParser/sankey_utils/node.py +340 -0
  11. SankeyExcelParser/sankey_utils/protos/__init__.py +0 -0
  12. SankeyExcelParser/sankey_utils/protos/flux.py +84 -0
  13. SankeyExcelParser/sankey_utils/protos/node.py +386 -0
  14. SankeyExcelParser/sankey_utils/protos/sankey_object.py +135 -0
  15. SankeyExcelParser/sankey_utils/protos/tag_group.py +95 -0
  16. SankeyExcelParser/sankey_utils/sankey_object.py +165 -0
  17. SankeyExcelParser/sankey_utils/table_object.py +37 -0
  18. SankeyExcelParser/sankey_utils/tag.py +95 -0
  19. SankeyExcelParser/sankey_utils/tag_group.py +206 -0
  20. SankeyExcelParser/su_trace.py +239 -0
  21. SankeyExcelParser/tests/integration/__init__.py +0 -0
  22. SankeyExcelParser/tests/integration/test_base.py +356 -0
  23. SankeyExcelParser/tests/integration/test_run_check_input.py +100 -0
  24. SankeyExcelParser/tests/integration/test_run_conversions.py +96 -0
  25. SankeyExcelParser/tests/integration/test_run_load_input.py +94 -0
  26. SankeyExcelParser/tests/unit/__init__.py +0 -0
  27. SankeyExcelParser-1.0.0b0.data/scripts/run_parse_and_write_excel.py +155 -0
  28. SankeyExcelParser-1.0.0b0.data/scripts/run_parse_excel.py +115 -0
  29. SankeyExcelParser-1.0.0b0.dist-info/METADATA +113 -0
  30. SankeyExcelParser-1.0.0b0.dist-info/RECORD +32 -0
  31. SankeyExcelParser-1.0.0b0.dist-info/WHEEL +5 -0
  32. SankeyExcelParser-1.0.0b0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,96 @@
1
+ """
2
+ Auteur : Vincent LE DOZE
3
+ Date : 07/12/23
4
+ """
5
+
6
+ # External libs ---------------------------------------------------------------
7
+ import argparse
8
+ import os
9
+ import unittest
10
+ from parameterized import parameterized
11
+
12
+ # Local modules ---------------------------------------------------------------
13
+ from SankeyExcelParser.tests.integration.test_base import MFAProblemsTests
14
+ from SankeyExcelParser.tests.integration.test_base import TEST_PARAMETERS
15
+ from SankeyExcelParser.io_excel import write_excel_from_sankey
16
+
17
+
18
+ # Class -----------------------------------------------------------------------
19
+ class MFAProblemTestConversion(MFAProblemsTests):
20
+
21
+ @parameterized.expand(TEST_PARAMETERS, skip_on_empty=True)
22
+ def test_conversions(
23
+ self,
24
+ test_name: str,
25
+ file_name: str,
26
+ expected_results: dict
27
+ ):
28
+ """
29
+ Check if rewriting Excel works as intended
30
+
31
+ Parameters
32
+ ----------
33
+ :param test_name: Name of current test
34
+ :type test_name: str
35
+
36
+ :param file_name: Name of current excel fil to test
37
+ :type file_name: str
38
+
39
+ :param expected_results: Dict of expected results to check with
40
+ :type expected_results: dict
41
+ """
42
+ # For Debug
43
+ print('\n{}'.format(self._testMethodName), end=' -> ', flush=True)
44
+ # Read and check file
45
+ (
46
+ sankey,
47
+ sheet_to_remove_names,
48
+ excel_filepath,
49
+ tmp_dir
50
+ ) = self.prepare_test(file_name, use_reconciled=False)
51
+ # Prepare output file
52
+ root_file_name = os.path.splitext(os.path.basename(excel_filepath))[0]
53
+ output_file_name = os.path.join(tmp_dir, root_file_name+'.xlsx')
54
+ # Write output file
55
+ write_excel_from_sankey(
56
+ output_file_name,
57
+ sankey,
58
+ mode='w',
59
+ sheets_to_remove__names=sheet_to_remove_names)
60
+
61
+
62
+ # Main ------------------------------------------------------------------------
63
+ if __name__ == '__main__':
64
+ # Get args
65
+ parser = argparse.ArgumentParser()
66
+ parser.add_argument(
67
+ "--generate_results",
68
+ action='store_true',
69
+ required=False,
70
+ help="Option to regenerate tests results")
71
+ parser.add_argument(
72
+ 'filenames',
73
+ metavar='F',
74
+ type=str,
75
+ nargs='*',
76
+ help='Specific files to test')
77
+ args = parser.parse_args()
78
+ # Generate test if needed
79
+ if args.generate_results:
80
+ MFAProblemsTests.set_generate_results()
81
+ # Get tests names to run
82
+ if len(args.filenames) == 0:
83
+ loader = unittest.TestLoader()
84
+ names = loader.getTestCaseNames(MFAProblemTestConversion)
85
+ else:
86
+ names = args.filenames
87
+ # Append tests to test suite
88
+ suite = unittest.TestSuite()
89
+ for name in names:
90
+ try:
91
+ suite.addTest(MFAProblemTestConversion(name))
92
+ except Exception:
93
+ print("Error when adding {} to test base".format(name))
94
+ # Run tests
95
+ runner = unittest.TextTestRunner()
96
+ runner.run(suite)
@@ -0,0 +1,94 @@
1
+ """
2
+ Auteur : Vincent LE DOZE
3
+ Date : 07/12/23
4
+ """
5
+
6
+ # External libs ---------------------------------------------------------------
7
+ import argparse
8
+ import unittest
9
+ from parameterized import parameterized
10
+
11
+ # Local modules ---------------------------------------------------------------
12
+ from SankeyExcelParser.tests.integration.test_base import MFAProblemsTests
13
+ from SankeyExcelParser.tests.integration.test_base import TEST_PARAMETERS
14
+ from SankeyExcelParser.tests.integration.test_base import LOGS_KEY
15
+
16
+
17
+ # Class -----------------------------------------------------------------------
18
+ class MFAProblemTestInput(MFAProblemsTests):
19
+
20
+ @parameterized.expand(TEST_PARAMETERS, skip_on_empty=True)
21
+ def test_excel_input(
22
+ self,
23
+ test_name: str,
24
+ file_name: str,
25
+ expected_results: dict
26
+ ):
27
+ """
28
+ Compare Sankey struct that is extracted from Excel file with expected results
29
+
30
+ Parameters
31
+ ----------
32
+ :param test_name: Name of current test
33
+ :type test_name: str
34
+
35
+ :param file_name: Excel file to test
36
+ :type file_name: str
37
+
38
+ :param expected_results: Dict that contains results to check with
39
+ :type expected_results: dict
40
+ """
41
+ # For Debug
42
+ print('\n{}'.format(self._testMethodName), end=' -> ', flush=True)
43
+ # Read and check file
44
+ (
45
+ sankey,
46
+ sheet_to_remove_names,
47
+ excel_filepath,
48
+ _
49
+ ) = self.prepare_test(file_name)
50
+ # Compare results
51
+ self.compare_sankey(
52
+ test_name,
53
+ sankey,
54
+ expected_results)
55
+ # Delete useless entries to avoid erasing previous results
56
+ if self.generate_results:
57
+ del expected_results[LOGS_KEY]
58
+
59
+
60
+ # Main ------------------------------------------------------------------------
61
+ if __name__ == '__main__':
62
+ # Get args
63
+ parser = argparse.ArgumentParser()
64
+ parser.add_argument(
65
+ "--generate_results",
66
+ action='store_true',
67
+ required=False,
68
+ help="Option to regenerate tests results")
69
+ parser.add_argument(
70
+ 'filenames',
71
+ metavar='F',
72
+ type=str,
73
+ nargs='*',
74
+ help='Specific files to test')
75
+ args = parser.parse_args()
76
+ # Generate test if needed
77
+ if args.generate_results:
78
+ MFAProblemsTests.set_generate_results()
79
+ # Get tests names to run
80
+ if len(args.filenames) == 0:
81
+ loader = unittest.TestLoader()
82
+ names = loader.getTestCaseNames(MFAProblemTestInput)
83
+ else:
84
+ names = args.filenames
85
+ # Append tests to test suite
86
+ suite = unittest.TestSuite()
87
+ for name in names:
88
+ try:
89
+ suite.addTest(MFAProblemTestInput(name))
90
+ except Exception:
91
+ print("Error when adding {} to test base".format(name))
92
+ # Run tests
93
+ runner = unittest.TextTestRunner()
94
+ runner.run(suite)
File without changes
@@ -0,0 +1,155 @@
1
+ #!python
2
+
3
+ # External libs -----------------------------------------------------
4
+ import sys
5
+ import os
6
+ import argparse
7
+ import tempfile
8
+ import time
9
+
10
+ # External modules -------------------------------------------------
11
+ from shutil import copyfile
12
+
13
+ # Local modules -----------------------------------------------------
14
+ from SankeyExcelParser import su_trace
15
+ from SankeyExcelParser.sankey import Sankey
16
+ from SankeyExcelParser.io_excel import load_sankey_from_excel_file
17
+ from SankeyExcelParser.io_excel import write_excel_from_sankey
18
+
19
+
20
+ # Functions ---------------------------------------------------------
21
+ def check_args():
22
+ ''' This function controls parameters passed to the program
23
+ '''
24
+ # Get args
25
+ parser = argparse.ArgumentParser()
26
+ parser.add_argument(
27
+ "--input_file",
28
+ required=True,
29
+ type=argparse.FileType('r'),
30
+ help="Input excel file (.xls or .xlsx)")
31
+ parser.add_argument(
32
+ "--output_dir",
33
+ default="tmp",
34
+ choices=['tmp', 'input', 'path'],
35
+ nargs='*',
36
+ help="'tmp', 'input' (same as input) or 'path'(full path without quote)")
37
+ args = parser.parse_args()
38
+ # Check if args are ok
39
+ input_file = args.input_file
40
+ iext = os.path.splitext(input_file.name)[1]
41
+ if iext not in ('.xls', '.xlsx'):
42
+ su_trace.logger.critical(
43
+ "Mauvaise extension pour le fichier d\'input.\n" +
44
+ parser.format_help())
45
+ sys.exit()
46
+ if type(args.output_dir) is not list:
47
+ args.output_dir = [args.output_dir]
48
+ # Return processed args
49
+ return input_file.name, args.output_dir, False
50
+
51
+
52
+ def log_time(t_start, t_cur, t_prev=None):
53
+ if t_prev is None:
54
+ log = '-- Took {} seconds --'.format(
55
+ round((t_cur-t_start), 2))
56
+ else:
57
+ log = '-- Took {0} / {1} seconds --'.format(
58
+ round((t_cur-t_prev), 2),
59
+ round((t_cur-t_start), 2))
60
+ return log
61
+
62
+
63
+ # Main ---------------------------------------------------------
64
+ if __name__ == '__main__':
65
+
66
+ log_file = su_trace.check_log()
67
+ su_trace.run_log(log_file)
68
+ su_trace.logger.info('[STARTED]')
69
+ t_start = time.time()
70
+
71
+ # 0. Get conversion arguments
72
+ t0 = time.time()
73
+ excel_input_filename, output_dir, debug = check_args()
74
+ if output_dir[0] == 'tmp':
75
+ output_directory = tempfile.mkdtemp()
76
+ if output_dir[0] == 'input':
77
+ output_directory = os.path.dirname(excel_input_filename)
78
+ if output_dir[0] == 'path':
79
+ output_directory = os.path.dirname(output_dir[1])
80
+
81
+ if debug:
82
+ su_trace.log_level("DEBUG")
83
+ t = time.time()
84
+ su_trace.logger.info('-- INPUT ARGUMENTS CHECKED --')
85
+ su_trace.logger.debug(log_time(t_start, t))
86
+ t_prev = t
87
+
88
+ # 1. load sankey struct from excel file
89
+ su_trace.logger.debug('-- LOAD SANKEY INPUT FROM EXCEL. --')
90
+ su_trace.logger.debug('Input file is : {}'.format(excel_input_filename))
91
+ sankey = Sankey()
92
+ ok, msg = load_sankey_from_excel_file(
93
+ excel_input_filename,
94
+ sankey)
95
+ t = time.time()
96
+ if (ok):
97
+ su_trace.logger.info('-- SANKEY INPUT LOADED FROM EXCEL SUCCEEDED --')
98
+ su_trace.logger.debug(log_time(t_start, t, t_prev))
99
+ else:
100
+ su_trace.logger.critical('-- ERROR : Loading Excel file has failed')
101
+ su_trace.logger.critical('-- {}'.format(msg))
102
+ su_trace.logger.info('-- SANKEY INPUT LOADED FROM EXCEL FAILED -- ')
103
+ su_trace.logger.debug(log_time(t_start, t, t_prev))
104
+ su_trace.logger.info('[FAILED]')
105
+ sys.exit()
106
+ t_prev = t
107
+ t1 = time.time()
108
+ # Log infos about arguments used
109
+ su_trace.logger.info('-- INPUT ARGUMENTS CHECKED, TOOK ' + str(round((t1-t0), 2)) + ' sec --')
110
+
111
+ # 2. Check sankey integrity
112
+ su_trace.logger.debug('-- CHECK SANKEY OVERALL STRUCTURE --')
113
+ ok, msg = sankey.check_overall_sankey_structure()
114
+ t = time.time()
115
+ if (ok):
116
+ su_trace.logger.info(
117
+ '-- SANKEY OVERALL STRUCTURE SUCCEEDED --')
118
+ su_trace.logger.debug(log_time(t_start, t, t_prev))
119
+ else:
120
+ su_trace.logger.critical(
121
+ '-- ERROR : Sankey overall checked has failed')
122
+ su_trace.logger.critical('-- {}'.format(msg))
123
+ su_trace.logger.info(
124
+ '-- SANKEY OVERALL STRUCTURE CHECK FAILED --')
125
+ su_trace.logger.debug(log_time(t_start, t, t_prev))
126
+ su_trace.logger.info('[FAILED]')
127
+ sys.exit()
128
+ t_prev = t
129
+
130
+ # 3. Writes results to excel
131
+ su_trace.logger.debug('-- REWRITE SANKEY TO EXCEL --')
132
+ try:
133
+ excel_root_filename = os.path.splitext(os.path.basename(excel_input_filename))[0]
134
+ excel_output_filename = os.path.join(output_directory, excel_root_filename+'_roundtrip'+'.xlsx')
135
+ copyfile(excel_input_filename, excel_output_filename)
136
+ su_trace.logger.info('-- Output file : {} '.format(excel_output_filename))
137
+ write_excel_from_sankey(
138
+ excel_output_filename,
139
+ sankey)
140
+ except Exception as excpt:
141
+ t = time.time()
142
+ su_trace.logger.critical('-- UNEXPECTED ERROR Rewriting sankey to excel file failed.')
143
+ su_trace.logger.critical('-- {}'.format(excpt))
144
+ su_trace.logger.info('-- REWRITE SANKEY TO EXCEL FAILED --')
145
+ su_trace.logger.debug(log_time(t_start, t, t_prev))
146
+ su_trace.logger.info('[FAILED]')
147
+ sys.exit()
148
+
149
+ t = time.time()
150
+ su_trace.logger.info('-- REWRITE SANKEY TO EXCEL DONE --')
151
+ su_trace.logger.debug(log_time(t_start, t, t_prev))
152
+
153
+ # End
154
+ su_trace.logger.info('[COMPLETED]')
155
+ su_trace.logger.debug(log_time(t_start, time.time()))
@@ -0,0 +1,115 @@
1
+ #!python
2
+
3
+ # External libs -----------------------------------------------------
4
+ import sys
5
+ import os
6
+ import argparse
7
+ import time
8
+
9
+ # External modules -------------------------------------------------
10
+ # ...
11
+
12
+ # Local modules -----------------------------------------------------
13
+
14
+ from SankeyExcelParser import su_trace
15
+ from SankeyExcelParser.sankey import Sankey
16
+ from SankeyExcelParser.io_excel import load_sankey_from_excel_file
17
+
18
+
19
+ # Functions ---------------------------------------------------------
20
+ def check_args():
21
+ ''' This function controls parameters passed to the program
22
+ '''
23
+ # Get args
24
+ parser = argparse.ArgumentParser()
25
+ parser.add_argument(
26
+ "--input_file",
27
+ required=True,
28
+ type=argparse.FileType('r'),
29
+ help="Input excel file (.xls or .xlsx)")
30
+ args = parser.parse_args()
31
+ # Check if args are ok
32
+ input_file = args.input_file
33
+ iext = os.path.splitext(input_file.name)[1]
34
+ if iext not in ('.xls', '.xlsx'):
35
+ su_trace.logger.critical(
36
+ "Mauvaise extension pour le fichier d\'input.\n" +
37
+ parser.format_help())
38
+ sys.exit()
39
+ # Return processed args
40
+ return input_file.name, False
41
+
42
+
43
+ def log_time(t_start, t_cur, t_prev=None):
44
+ if t_prev is None:
45
+ log = '-- Took {} seconds --'.format(
46
+ round((t_cur-t_start), 2))
47
+ else:
48
+ log = '-- Took {0} / {1} seconds --'.format(
49
+ round((t_cur-t_prev), 2),
50
+ round((t_cur-t_start), 2))
51
+ return log
52
+
53
+
54
+ # Main ---------------------------------------------------------
55
+ if __name__ == '__main__':
56
+
57
+ log_file = su_trace.check_log()
58
+ su_trace.run_log(log_file)
59
+ su_trace.logger.info('[STARTED]')
60
+ t_start = time.time()
61
+
62
+ # 0. Get conversion arguments
63
+ excel_input_filename, debug = check_args()
64
+ if debug:
65
+ su_trace.log_level("DEBUG")
66
+ t = time.time()
67
+ su_trace.logger.info('-- INPUT ARGUMENTS CHECKED --')
68
+ su_trace.logger.debug(log_time(t_start, t))
69
+ t_prev = t
70
+
71
+ # 1. load sankey struct from excel file
72
+ su_trace.logger.debug('-- LOAD MFA PROBLEM INPUT FROM EXCEL. --')
73
+ su_trace.logger.debug('Input file is : {}'.format(excel_input_filename))
74
+ sankey = Sankey()
75
+ ok, msg = load_sankey_from_excel_file(
76
+ excel_input_filename,
77
+ sankey)
78
+ t = time.time()
79
+ if (ok):
80
+ su_trace.logger.info(
81
+ '-- MFA PROBLEM INPUT LOADED FROM EXCEL SUCCEEDED --')
82
+ su_trace.logger.debug(log_time(t_start, t, t_prev))
83
+ else:
84
+ su_trace.logger.critical(
85
+ '-- ERROR : Loading Excel file has failed')
86
+ su_trace.logger.critical('-- {}'.format(msg))
87
+ su_trace.logger.info(
88
+ '-- MFA PROBLEM INPUT LOADED FROM EXCEL FAILED -- ')
89
+ su_trace.logger.debug(log_time(t_start, t, t_prev))
90
+ su_trace.logger.info('[FAILED]')
91
+ sys.exit()
92
+ t_prev = t
93
+
94
+ # 2. Check sankey integrity
95
+ su_trace.logger.debug('-- CHECK MFA PROBLEM OVERALL STRUCTURE --')
96
+ ok, msg = sankey.check_overall_sankey_structure()
97
+ t = time.time()
98
+ if (ok):
99
+ su_trace.logger.info(
100
+ '-- MFA PROBLEM OVERALL STRUCTURE SUCCEEDED --')
101
+ su_trace.logger.debug(log_time(t_start, t, t_prev))
102
+ else:
103
+ su_trace.logger.critical(
104
+ '-- ERROR : Sankey overall checked has failed')
105
+ su_trace.logger.critical('-- {}'.format(msg))
106
+ su_trace.logger.info(
107
+ '-- MFA PROBLEM OVERALL STRUCTURE CHECK FAILED --')
108
+ su_trace.logger.debug(log_time(t_start, t, t_prev))
109
+ su_trace.logger.info('[FAILED]')
110
+ sys.exit()
111
+ t_prev = t
112
+
113
+ # End
114
+ su_trace.logger.info('[COMPLETED]')
115
+ su_trace.logger.debug(log_time(t_start, time.time()))
@@ -0,0 +1,113 @@
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
+
@@ -0,0 +1,32 @@
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,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: bdist_wheel (0.38.4)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1 @@
1
+ SankeyExcelParser