refactor API & Docs

[aniketmaurya]

Changes

Fixes # (issue)

Type of change

• Documentation Update
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings

[pep8speaks]

Hello @aniketmaurya! Thanks for updating this PR.

• In the file chitra/utility/import_utils.py:

Line 21:5: W503 line break before binary operator
Line 22:5: W503 line break before binary operator
Line 23:5: W503 line break before binary operator

Comment last updated at 2021-07-17 14:36:50 UTC

[codecov]

Codecov Report

Merging #93 (4143fd9) into master (c50af17) will increase coverage by 0.28%.
The diff coverage is 93.10%.

@@            Coverage Diff             @@
##           master      #93      +/-   ##
==========================================
+ Coverage   67.55%   67.83%   +0.28%     
==========================================
  Files          34       35       +1     
  Lines        1125     1138      +13     
==========================================
+ Hits          760      772      +12     
- Misses        365      366       +1     

Flag	Coverage Δ
unittests	67.83% <93.10%> (+0.28%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
chitra/dataloader.py	44.08% <ø> (ø)
chitra/image.py	78.57% <75.00%> (ø)
chitra/serve/model_server.py	60.22% <87.50%> (+0.22%)	⬆️
chitra/__about__.py	100.00% <100.00%> (ø)
chitra/__init__.py	100.00% <100.00%> (ø)
chitra/logging.py	66.66% <100.00%> (ø)
chitra/serve/__init__.py	100.00% <100.00%> (ø)
chitra/serve/data_processing/processor.py	66.66% <100.00%> (ø)
chitra/serve/data_processing/vision.py	31.57% <100.00%> (ø)
chitra/serve/schema/__init__.py	100.00% <100.00%> (ø)
... and 2 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c50af17...4143fd9. Read the comment docs.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

93.1% Coverage
0.0% Duplication