Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Initialization Testing #50

Merged
merged 7 commits into from May 17, 2021
Merged

Initialization Testing #50

merged 7 commits into from May 17, 2021

Conversation

quantum9Innovation
Copy link
Member

Adds initialization testing to package

From PR #48, after PR #49

New Feature

Adds sanity and dependency checks to the epispot/__init__.py file and adds classifiers and other metadata to both setup.py and setup-nightly.py.

Known Issues

No known issues.

Code Breakdown

  • epispot/__init__.py
    • Sanity checks
    • Dependency checks
    • Increased package documentation
      • Ported from README.md
  • release.py
    • Updated to be compatible with new initialization file
  • setup.py, setup-nightly.py
    • Adds classifiers
    • Adds more URLs

@quantum9Innovation
Adds sanity and dependency checking
512223a 
epispot/__init__.py is now equipped with sanity checks and dependency checks that can be called through a testing framework. Additionally, the top of the initialization file has been fitted with a copy of the README to provide enhanced documentation support.
Refractorings:
 - Metadata formated as `__name__` has been changed to `name` to make it globally accessible (and have it be rendered into documentation by pdoc)
 Ex: `epispot.__version__` is now `epispot.version`
@quantum9Innovation
Adds more classifiers to setup files
efb5871 
- setup.py
- setup-nightly.py
@quantum9Innovation quantum9Innovation added doc 📜 Improvements or additions to documentation feat 🚀 New feature or request low-priority 🔽 Will be worked on later labels May 13, 2021
@github-actions github-actions bot added the src Changes to the package source code label May 13, 2021
@quantum9Innovation quantum9Innovation added this to Needs triage in Management v2 via automation May 13, 2021
@quantum9Innovation quantum9Innovation moved this from Needs triage to Low priority in Management v2 May 13, 2021
@codecov
Copy link

codecov bot commented May 13, 2021 •
edited

Codecov Report

Merging #50 (0979dd9) into master (009d5f2) will decrease coverage by 7.42%.
The diff coverage is 27.27%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #50      +/-   ##
==========================================
- Coverage   97.44%   90.01%   -7.43%     
==========================================
  Files           6        7       +1     
  Lines         470      521      +51     
==========================================
+ Hits          458      469      +11     
- Misses         12       52      +40
Impacted Files Coverage Δ
bin/bcolors.py 0.00% <0.00%> (ø)
epispot/__init__.py 100.00% <100.00%> (ø)

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 99e1f24...0979dd9. Read the comment docs.

@lgtm-com
Copy link

lgtm-com bot commented May 13, 2021

This pull request introduces 1 alert when merging efb5871 into ad874ff - view on LGTM.com

new alerts:

  • 1 for Module is imported with 'import' and 'import from'

@quantum9Innovation
Copy link
Member Author

quantum9Innovation commented May 14, 2021 •
edited

Merging Guidelines

Test analysis

Build → passing ✅
Code Coverage → not failing* (no change 🏳️ )
CodeQL → passing ✅
DeepSource → passing ✅
LGTM→ failing ❌

*Code coverage reporting on the master branch is currently incorrect. This will be fixed in a later PR

Merge after

@quantum9Innovation
Copy link
Member Author

Update

Waiting for @Quantalabs before fixing LGTM alerts

@quantum9Innovation
Copy link
Member Author

Update

Waiting for @Quantalabs before fixing LGTM alerts

@Quantalabs

Quantalabs
Quantalabs requested changes May 16, 2021
View reviewed changes
epispot/__init__.py Outdated Show resolved Hide resolved
epispot/__init__.py Show resolved Hide resolved
epispot/__init__.py Show resolved Hide resolved
quantum9Innovation and others added 3 commits May 16, 2021 16:49
@quantum9Innovation
Adds .. include:: ../README.md suggestion by @Quantalabs
4579cbb 
pdoc3 will now use the README to display documentation for epispot but the Python `help()` command will return epispot's inline documentation.
@quantum9Innovation @Quantalabs
Deletes built-in checks after running them
7f36e5e 
Suggestion by @Quantalabs on PR #50

Co-authored-by: QLabs <55121845+Quantalabs@users.noreply.github.com>
@quantum9Innovation
Fixes syntax error introduced in previous commit
21990ee 
Deletes *function*, not function *call*
@quantum9Innovation
Copy link
Member Author

quantum9Innovation commented May 17, 2021 •
edited

Merge Process

  • CodeQL must pass ✔️
  • LGTM must pass ✔️
  • Approving review from @Quantalabs ✔️

Merge method undetermined as of yet

@lgtm-com
Copy link

lgtm-com bot commented May 17, 2021

This pull request introduces 1 alert when merging 3a09b06 into ad874ff - view on LGTM.com

new alerts:

  • 1 for Module is imported with 'import' and 'import from'

Quantalabs
Quantalabs approved these changes May 17, 2021
View reviewed changes
Copy link
Member

@Quantalabs Quantalabs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@quantum9Innovation
Suppresses LGTM double-import alert
0979dd9 
Alert: Module is imported with 'import' and 'import from' @ epispot/__init__.py 98:28
Supresses with: `# lgtm [py/import-and-import-from]
@lgtm-com
Copy link

lgtm-com bot commented May 17, 2021

This pull request introduces 1 alert when merging 0979dd9 into ad874ff - view on LGTM.com

new alerts:

  • 1 for Module is imported with 'import' and 'import from'

@quantum9Innovation quantum9Innovation merged commit 6517695 into master May 17, 2021
Management v2 automation moved this from Low priority to Closed May 17, 2021
@quantum9Innovation quantum9Innovation deleted the testing-init branch May 19, 2021 19:09
This was referenced May 19, 2021
Merged
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Quantalabs Quantalabs Quantalabs approved these changes

Assignees
No one assigned
Labels
doc 📜 Improvements or additions to documentation feat 🚀 New feature or request low-priority 🔽 Will be worked on later src Changes to the package source code
Projects
No open projects
Management v2
  
Closed
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@quantum9Innovation @Quantalabs