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.

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

Add codecov, pipenv, black, pre-commit #83

Merged
merged 16 commits into from
Oct 17, 2021
Merged

Conversation

eigenmannmartin
Copy link
Member

@eigenmannmartin eigenmannmartin commented Oct 11, 2021

I have added the following things:

  • codecov
  • pipenv
  • black
  • pre-commit

Pre-commit was added by someone else and it makes sense I think.

Black allows us to remove any guesswork about formatting 😄

Makes repeated builds much more reliable.

@eigenmannmartin eigenmannmartin marked this pull request as draft October 11, 2021 06:37
@codecov
Copy link

codecov bot commented Oct 11, 2021

Codecov Report

❗ No coverage uploaded for pull request base (master@ebe2c2c). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master      #83   +/-   ##
=========================================
  Coverage          ?   85.04%           
=========================================
  Files             ?        4           
  Lines             ?      341           
  Branches          ?       81           
=========================================
  Hits              ?      290           
  Misses            ?       27           
  Partials          ?       24           

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 ebe2c2c...adc7d67. Read the comment docs.

@eigenmannmartin eigenmannmartin changed the title Add codecov Add codecov, pipenv, black Oct 11, 2021
@eigenmannmartin eigenmannmartin changed the title Add codecov, pipenv, black Add codecov, pipenv, black, pre-commit Oct 11, 2021
@eigenmannmartin eigenmannmartin marked this pull request as ready for review October 11, 2021 17:53
@Hultner
Copy link
Member

Hultner commented Oct 11, 2021

Overall great initiative there's only one thing in hesitant about, which is pipenv.

Pipenv is mainly geared towards application development, I’d much rather use poetry or similar which is meant for library/package development. Shouldn’t be too hard to migrate. What do you think?

@eigenmannmartin
Copy link
Member Author

Overall great initiative there's only one thing in hesitant about, which is pipenv.

Pipenv is mainly geared towards application development, I’d much rather use poetry or similar which is meant for library/package development. Shouldn’t be too hard to migrate. What do you think?

fair point! :-)
give me a few minutes

@eigenmannmartin
Copy link
Member Author

I also update the readme and bumped the version in the project.toml to 0.1.26

I am also thinking about adding bandit at some point.

@Hultner
Copy link
Member

Hultner commented Oct 11, 2021

I also update the readme and bumped the version in the project.toml to 0.1.26

I am also thinking about adding bandit at some point.

Bandit is nice, pyflakes would also be nice.

@eigenmannmartin
Copy link
Member Author

I also update the readme and bumped the version in the project.toml to 0.1.26
I am also thinking about adding bandit at some point.

Bandit is nice, pyflakes would also be nice.

yes - but not in this pr :-)

python -m pip install --upgrade pip
pip install poetry==1.1.11
poetry install
- name: Test with pytest
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn’t we enforce all our static checks here as well? Like black formatting.

Copy link
Member Author

Choose a reason for hiding this comment

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

the are enforced with pre-commit. this also runs on every commit here as check

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Every thing we’ve got in pre-commit should be enforced in GH-Actions as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

But it is enforced as an action - it runs as check.
image

@Hultner
Copy link
Member

Hultner commented Oct 11, 2021 via email

@Hultner
Copy link
Member

Hultner commented Oct 11, 2021 via email

@eigenmannmartin
Copy link
Member Author

eigenmannmartin commented Oct 11, 2021

Is pre commit being run in CI?

yes :-)

It runs check locally only for files in the current commit and for everything in the cloud.

@Hultner
Copy link
Member

Hultner commented Oct 11, 2021 via email

@eigenmannmartin eigenmannmartin requested review from Hultner and a user October 12, 2021 21:06
@eigenmannmartin
Copy link
Member Author

@Hultner do you think this pr is ok like it is?

Copy link
Member

@Hultner Hultner 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 to me 👍

@eigenmannmartin eigenmannmartin merged commit dd3dad6 into master Oct 17, 2021
@eigenmannmartin eigenmannmartin deleted the f/add-codecov branch October 17, 2021 16:23
rtpg added a commit to jazzband/django-taggit that referenced this pull request Nov 10, 2021
 This follows what was done at jazzband/icalevents#83.
auvipy pushed a commit to jazzband/django-taggit that referenced this pull request Nov 10, 2021
 This follows what was done at jazzband/icalevents#83.
capuanob pushed a commit to ennamarie19/icalevents that referenced this pull request Mar 6, 2023
Add codecov, pipenv, black, pre-commit
ipyramiddev added a commit to ipyramiddev/taggit-api-django that referenced this pull request Mar 22, 2023
 This follows what was done at jazzband/icalevents#83.
code-worm19 added a commit to code-worm19/taggot-api-django that referenced this pull request Jan 23, 2025
 This follows what was done at jazzband/icalevents#83.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants