[SYNPY-1362] High level best practices for project structure

[thomasyu888]

Problem

There is currently not a best practices doc on project structure with your data.

[pep8speaks]

Hello @thomasyu888! Thanks for opening this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file synapseclient/activity.py:

Line 7:89: E501 line too long (107 > 88 characters)
Line 47:89: E501 line too long (102 > 88 characters)
Line 138:89: E501 line too long (174 > 88 characters)
Line 142:89: E501 line too long (132 > 88 characters)

• In the file synapseclient/annotations.py:

Line 24:89: E501 line too long (102 > 88 characters)
Line 45:89: E501 line too long (99 > 88 characters)
Line 57:89: E501 line too long (92 > 88 characters)
Line 102:89: E501 line too long (99 > 88 characters)
Line 128:89: E501 line too long (103 > 88 characters)
Line 131:89: E501 line too long (92 > 88 characters)
Line 145:89: E501 line too long (98 > 88 characters)
Line 146:89: E501 line too long (95 > 88 characters)
Line 153:89: E501 line too long (118 > 88 characters)
Line 161:89: E501 line too long (110 > 88 characters)
Line 164:89: E501 line too long (107 > 88 characters)
Line 221:89: E501 line too long (109 > 88 characters)
Line 242:89: E501 line too long (135 > 88 characters)
Line 245:89: E501 line too long (89 > 88 characters)
Line 248:89: E501 line too long (110 > 88 characters)
Line 277:89: E501 line too long (98 > 88 characters)
Line 278:89: E501 line too long (94 > 88 characters)

• In the file synapseclient/client.py:

Line 217:89: E501 line too long (99 > 88 characters)
Line 336:89: E501 line too long (91 > 88 characters)
Line 431:89: E501 line too long (89 > 88 characters)
Line 433:89: E501 line too long (103 > 88 characters)
Line 436:89: E501 line too long (99 > 88 characters)
Line 437:89: E501 line too long (115 > 88 characters)
Line 439:89: E501 line too long (113 > 88 characters)
Line 441:89: E501 line too long (108 > 88 characters)
Line 443:89: E501 line too long (110 > 88 characters)
Line 484:89: E501 line too long (90 > 88 characters)
Line 632:89: E501 line too long (91 > 88 characters)
Line 998:89: E501 line too long (111 > 88 characters)
Line 999:89: E501 line too long (108 > 88 characters)
Line 1011:89: E501 line too long (113 > 88 characters)
Line 1012:89: E501 line too long (116 > 88 characters)
Line 1135:89: E501 line too long (100 > 88 characters)
Line 1136:89: E501 line too long (105 > 88 characters)
Line 1393:89: E501 line too long (104 > 88 characters)
Line 1394:89: E501 line too long (100 > 88 characters)
Line 1397:89: E501 line too long (93 > 88 characters)
Line 1398:89: E501 line too long (107 > 88 characters)
Line 1399:89: E501 line too long (108 > 88 characters)
Line 1400:89: E501 line too long (89 > 88 characters)
Line 1401:89: E501 line too long (113 > 88 characters)
Line 1404:89: E501 line too long (111 > 88 characters)
Line 1405:89: E501 line too long (100 > 88 characters)
Line 1406:89: E501 line too long (108 > 88 characters)
Line 1408:89: E501 line too long (111 > 88 characters)
Line 1409:89: E501 line too long (106 > 88 characters)
Line 1434:89: E501 line too long (106 > 88 characters)
Line 1793:89: E501 line too long (96 > 88 characters)
Line 1903:89: E501 line too long (118 > 88 characters)
Line 1905:89: E501 line too long (117 > 88 characters)
Line 1907:89: E501 line too long (118 > 88 characters)
Line 1909:89: E501 line too long (112 > 88 characters)
Line 1911:89: E501 line too long (117 > 88 characters)
Line 1932:89: E501 line too long (114 > 88 characters)
Line 2104:89: E501 line too long (107 > 88 characters)
Line 2154:89: E501 line too long (100 > 88 characters)
Line 2165:89: E501 line too long (94 > 88 characters)
Line 2169:89: E501 line too long (100 > 88 characters)
Line 2171:89: E501 line too long (95 > 88 characters)
Line 2227:89: E501 line too long (94 > 88 characters)
Line 2228:89: E501 line too long (105 > 88 characters)
Line 2429:89: E501 line too long (100 > 88 characters)
Line 2431:89: E501 line too long (104 > 88 characters)
Line 2435:89: E501 line too long (116 > 88 characters)
Line 2436:89: E501 line too long (103 > 88 characters)
Line 2507:89: E501 line too long (99 > 88 characters)
Line 3084:89: E501 line too long (95 > 88 characters)
Line 3085:89: E501 line too long (90 > 88 characters)
Line 3087:89: E501 line too long (110 > 88 characters)
Line 3092:89: E501 line too long (105 > 88 characters)
Line 3199:89: E501 line too long (102 > 88 characters)
Line 3201:89: E501 line too long (95 > 88 characters)
Line 3211:89: E501 line too long (107 > 88 characters)
Line 3216:89: E501 line too long (108 > 88 characters)
Line 3222:89: E501 line too long (128 > 88 characters)
Line 3270:89: E501 line too long (116 > 88 characters)
Line 3315:89: E501 line too long (92 > 88 characters)
Line 3343:89: E501 line too long (95 > 88 characters)
Line 3344:89: E501 line too long (94 > 88 characters)
Line 3345:89: E501 line too long (103 > 88 characters)
Line 3347:89: E501 line too long (91 > 88 characters)
Line 3348:89: E501 line too long (99 > 88 characters)
Line 3349:89: E501 line too long (115 > 88 characters)
Line 3350:89: E501 line too long (100 > 88 characters)
Line 3379:89: E501 line too long (103 > 88 characters)
Line 3380:89: E501 line too long (92 > 88 characters)
Line 3381:89: E501 line too long (117 > 88 characters)
Line 3382:89: E501 line too long (91 > 88 characters)
Line 3389:89: E501 line too long (114 > 88 characters)
Line 3477:89: E501 line too long (93 > 88 characters)
Line 3480:89: E501 line too long (124 > 88 characters)
Line 3662:89: E501 line too long (98 > 88 characters)
Line 3733:89: E501 line too long (108 > 88 characters)
Line 3734:89: E501 line too long (126 > 88 characters)
Line 3735:89: E501 line too long (124 > 88 characters)
Line 3737:89: E501 line too long (120 > 88 characters)
Line 3739:89: E501 line too long (103 > 88 characters)
Line 3754:89: E501 line too long (102 > 88 characters)
Line 3940:89: E501 line too long (94 > 88 characters)
Line 4024:89: E501 line too long (89 > 88 characters)
Line 4027:89: E501 line too long (141 > 88 characters)
Line 4171:89: E501 line too long (104 > 88 characters)
Line 4386:89: E501 line too long (116 > 88 characters)
Line 4435:89: E501 line too long (104 > 88 characters)
Line 4436:89: E501 line too long (92 > 88 characters)
Line 4581:89: E501 line too long (119 > 88 characters)
Line 4584:89: E501 line too long (116 > 88 characters)
Line 4602:89: E501 line too long (190 > 88 characters)
Line 4603:89: E501 line too long (135 > 88 characters)
Line 4604:89: E501 line too long (100 > 88 characters)
Line 4616:89: E501 line too long (129 > 88 characters)
Line 4620:89: E501 line too long (116 > 88 characters)
Line 4622:89: E501 line too long (92 > 88 characters)
Line 5187:89: E501 line too long (112 > 88 characters)
Line 5318:89: E501 line too long (103 > 88 characters)
Line 5319:89: E501 line too long (103 > 88 characters)
Line 5320:89: E501 line too long (111 > 88 characters)
Line 5349:89: E501 line too long (103 > 88 characters)
Line 5350:89: E501 line too long (103 > 88 characters)
Line 5351:89: E501 line too long (111 > 88 characters)
Line 5387:89: E501 line too long (103 > 88 characters)
Line 5388:89: E501 line too long (103 > 88 characters)
Line 5389:89: E501 line too long (111 > 88 characters)
Line 5416:89: E501 line too long (103 > 88 characters)
Line 5417:89: E501 line too long (103 > 88 characters)
Line 5418:89: E501 line too long (111 > 88 characters)

• In the file synapseclient/entity.py:

Line 62:89: E501 line too long (90 > 88 characters)
Line 116:89: E501 line too long (124 > 88 characters)
Line 118:89: E501 line too long (106 > 88 characters)
Line 563:89: E501 line too long (120 > 88 characters)
Line 564:89: E501 line too long (121 > 88 characters)
Line 565:89: E501 line too long (119 > 88 characters)
Line 566:89: E501 line too long (119 > 88 characters)
Line 583:89: E501 line too long (91 > 88 characters)
Line 585:89: E501 line too long (99 > 88 characters)
Line 587:89: E501 line too long (91 > 88 characters)
Line 589:89: E501 line too long (102 > 88 characters)
Line 590:89: E501 line too long (106 > 88 characters)
Line 781:89: E501 line too long (101 > 88 characters)
Line 782:89: E501 line too long (108 > 88 characters)

• In the file synapseclient/table.py:

Line 6:89: E501 line too long (101 > 88 characters)
Line 8:89: E501 line too long (119 > 88 characters)
Line 21:89: E501 line too long (103 > 88 characters)

• In the file synapseutils/copy_functions.py:

Line 40:89: E501 line too long (103 > 88 characters)
Line 41:89: E501 line too long (111 > 88 characters)
Line 42:89: E501 line too long (95 > 88 characters)
Line 43:89: E501 line too long (109 > 88 characters)
Line 44:89: E501 line too long (103 > 88 characters)
Line 46:89: E501 line too long (108 > 88 characters)
Line 47:89: E501 line too long (110 > 88 characters)
Line 49:89: E501 line too long (105 > 88 characters)
Line 50:89: E501 line too long (106 > 88 characters)
Line 54:89: E501 line too long (99 > 88 characters)
Line 236:89: E501 line too long (140 > 88 characters)
Line 246:89: E501 line too long (99 > 88 characters)
Line 290:89: E501 line too long (95 > 88 characters)
Line 294:89: E501 line too long (99 > 88 characters)
Line 295:89: E501 line too long (95 > 88 characters)
Line 297:89: E501 line too long (100 > 88 characters)
Line 299:89: E501 line too long (92 > 88 characters)
Line 301:89: E501 line too long (116 > 88 characters)
Line 317:89: E501 line too long (122 > 88 characters)
Line 321:89: E501 line too long (102 > 88 characters)
Line 322:89: E501 line too long (89 > 88 characters)
Line 747:89: E501 line too long (89 > 88 characters)
Line 748:89: E501 line too long (104 > 88 characters)
Line 749:89: E501 line too long (105 > 88 characters)
Line 751:89: E501 line too long (106 > 88 characters)
Line 753:89: E501 line too long (98 > 88 characters)

• In the file synapseutils/migrate_functions.py:

Line 161:89: E501 line too long (106 > 88 characters)
Line 164:89: E501 line too long (113 > 88 characters)
Line 165:89: E501 line too long (104 > 88 characters)
Line 272:89: E501 line too long (89 > 88 characters)
Line 277:89: E501 line too long (102 > 88 characters)
Line 278:89: E501 line too long (104 > 88 characters)
Line 281:89: E501 line too long (113 > 88 characters)
Line 282:89: E501 line too long (104 > 88 characters)
Line 618:89: E501 line too long (107 > 88 characters)
Line 619:89: E501 line too long (108 > 88 characters)
Line 622:89: E501 line too long (104 > 88 characters)
Line 624:89: E501 line too long (98 > 88 characters)
Line 628:89: E501 line too long (90 > 88 characters)

• In the file synapseutils/sync.py:

Line 88:89: E501 line too long (149 > 88 characters)
Line 89:89: E501 line too long (117 > 88 characters)
Line 91:89: E501 line too long (128 > 88 characters)
Line 95:89: E501 line too long (114 > 88 characters)
Line 894:89: E501 line too long (90 > 88 characters)
Line 990:89: E501 line too long (90 > 88 characters)

• In the file synapseutils/walk_functions.py:

Line 27:89: E501 line too long (94 > 88 characters)
Line 30:89: E501 line too long (92 > 88 characters)

[BryanFauble]

@thomasyu888 You'll need to add this to the navigation in mkdocs.yml

https://github.com/Sage-Bionetworks/synapsePythonClient/blob/develop/mkdocs.yml#L16

[BryanFauble]

Excellent work! LGTM!

[sonarqubecloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud