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

Adopt pyproject.toml and poetry packaging system #32

Merged
merged 19 commits into from
May 24, 2022
Merged

Adopt pyproject.toml and poetry packaging system #32

merged 19 commits into from
May 24, 2022

Conversation

frthjf
Copy link
Contributor

@frthjf frthjf commented May 19, 2022 •
edited by skim0119
Loading

  • Removes setup.py in favor of poetry + pyproject.toml
  • Apply isort and resolve circular import issues
  • Add .editorconfig
  • Add puplish-to-pypi workflow to build and release to pypi via GitHub releases (requires setup of API key)
  • Makes version specifier in pyproject.toml single source of truth
  • Bumps black formatter to v2022
  • Add py.typed file
  • Add dependabot workflow to keep dependencies up to date? (future)

Closes #31

@skim0119 skim0119 added this to the Version 0.1.0 milestone May 20, 2022
@skim0119 skim0119 added enhancement New feature or request prio:mid Middle-priority issue labels May 20, 2022
@frthjf frthjf mentioned this pull request May 22, 2022
Closed
@skim0119
Merge update 0.0.5 into feature/pyproject-poetry
54dba5c 
Resolved conflict: removed version file and updated in toml file.
@skim0119
Copy link
Collaborator

@frthjf I can help get rid of some test failure cases. I'll directly work on this branch.

skim0119 added 4 commits May 22, 2022 17:02
@skim0119
fix: mean firing rate unittest
3a0adae
@skim0119
update: ignore examples written in docstring
29cff35
@skim0119
update: remove docteset
4fed1a6 
Current documentation include use cases that cannot be reproduced (ex.
data loading). The primary purpose of examples are not to test
functionality, rather to hint scripts to users. We can revisit how to
include doctest in the future.
@skim0119
update: relocate coverage token, update pyproject
7c44d58
@codecov-commenter
Copy link

codecov-commenter commented May 23, 2022 •
edited
Loading

Codecov Report

Merging #32 (5e9d9a6) into main (abd6146) will decrease coverage by 0.18%.
The diff coverage is 78.66%.

@@            Coverage Diff             @@
##             main      #32      +/-   ##
==========================================
- Coverage   50.52%   50.33%   -0.19%     
==========================================
  Files          20       20              
  Lines         572      590      +18     
  Branches       64       67       +3     
==========================================
+ Hits          289      297       +8     
- Misses        282      291       +9     
- Partials        1        2       +1
Flag Coverage Δ
unittests 50.33% <78.66%> (?)

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

Impacted Files Coverage Δ
miv/io/data.py 29.75% <41.17%> (-0.53%) ⬇️
miv/signal/filter/filter_collection.py 94.44% <60.00%> (-5.56%) ⬇️
miv/io/binary.py 67.27% <75.00%> (ø)
miv/__init__.py 77.77% <77.77%> (ø)
miv/signal/spike/sorting.py 23.89% <88.88%> (+0.20%) ⬆️
miv/io/__init__.py 100.00% <100.00%> (ø)
miv/signal/filter/__init__.py 100.00% <100.00%> (ø)
miv/signal/filter/butter_bandpass_filter.py 76.74% <100.00%> (ø)
miv/signal/filter/median_filter.py 51.85% <100.00%> (ø)
miv/signal/filter/protocol.py 84.61% <100.00%> (-1.10%) ⬇️
... and 7 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 2604ac1...5e9d9a6. Read the comment docs.

@skim0119
Copy link
Collaborator

I'm planning on including dependabot in the future, but lets keep it out for this PR.

@frthjf
Copy link
Contributor Author

frthjf commented May 23, 2022

Sounds good, thanks!

armantekinalp
armantekinalp approved these changes May 24, 2022
View reviewed changes
Copy link
Collaborator

@armantekinalp armantekinalp left a comment

Choose a reason for hiding this comment

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

LGTM. Nice job!

@skim0119
Copy link
Collaborator

I'm removing .github/workflows/publish-to-pypi.yml for now. I'll add it later once we finalize the first version.

Looks good. Thank you @frthjf

skim0119
skim0119 approved these changes May 24, 2022
View reviewed changes
Copy link
Collaborator

@skim0119 skim0119 left a comment

Choose a reason for hiding this comment

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

LGTM

@skim0119 skim0119 merged commit 6ed0082 into GazzolaLab:main May 24, 2022
@frthjf frthjf deleted the feature/pyproject-poetry branch May 24, 2022 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skim0119 skim0119 skim0119 approved these changes

@armantekinalp armantekinalp armantekinalp approved these changes

Assignees

@frthjf frthjf

Labels
enhancement New feature or request prio:mid Middle-priority issue
Projects
None yet
Milestone
Version 0.1.0
Development

Successfully merging this pull request may close these issues.

Setup pyproject
4 participants
@frthjf @skim0119 @codecov-commenter @armantekinalp