jazzband / icalevents

Python module for iCal URL/file parsing and querying.
MIT License
160 stars 72 forks source link

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

Closed eigenmannmartin closed 2 years ago

eigenmannmartin commented 2 years ago

I have added the following things:

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

Black allows us to remove any guesswork about formatting :smile:

Makes repeated builds much more reliable.

codecov[bot] commented 2 years ago

Codecov Report

:exclamation: 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.

Hultner commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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 :-)

Hultner commented 2 years ago

Agreed, I was just brainstorming :)

On Mon, 11 Oct 2021 at 20:27, Martin Eigenmann @.***> wrote:

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 :-)

— You are receiving this because your review was requested. Reply to this email directly, view it on GitHub https://github.com/jazzband/icalevents/pull/83#issuecomment-940316833, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAULT2VZ462MVUM74BZBWV3UGMT75ANCNFSM5FXOY5PQ .

-- Med vänlig hälsning Alexander Hultnér

Hultner commented 2 years ago

Is pre commit being run in CI?

On Mon, 11 Oct 2021 at 20:30, Martin Eigenmann @.***> wrote:

@.**** commented on this pull request.

In .github/workflows/python-test.yml https://github.com/jazzband/icalevents/pull/83#discussion_r726490864:

  • exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide

  • flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
    • name: Test with pytest
  • run: |
  • pytest
    • uses: @.***
    • name: Set up Python 3.9
  • uses: @.***
  • with:
  • python-version: 3.9
    • name: Install dependencies
  • run: |
  • python -m pip install --upgrade pip
  • pip install poetry==1.1.11
  • poetry install
    • name: Test with pytest

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

— You are receiving this because your review was requested. Reply to this email directly, view it on GitHub https://github.com/jazzband/icalevents/pull/83#discussion_r726490864, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAULT2WMMQHV76QPOBBLFVTUGMUL7ANCNFSM5FXOY5PQ .

-- Med vänlig hälsning Alexander Hultnér

eigenmannmartin commented 2 years ago

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 commented 2 years ago

Ohh, I’m on my phone making dinner, totally missed that!

On Mon, 11 Oct 2021 at 20:32, Martin Eigenmann @.***> wrote:

@.**** commented on this pull request.

In .github/workflows/python-test.yml https://github.com/jazzband/icalevents/pull/83#discussion_r726492210:

  • exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide

  • flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
    • name: Test with pytest
  • run: |
  • pytest
    • uses: @.***
    • name: Set up Python 3.9
  • uses: @.***
  • with:
  • python-version: 3.9
    • name: Install dependencies
  • run: |
  • python -m pip install --upgrade pip
  • pip install poetry==1.1.11
  • poetry install
    • name: Test with pytest

But it is enforced as an action - it runs as check. [image: image] https://user-images.githubusercontent.com/2293142/136837739-97897bca-49a7-486d-acfd-cb379d3ba918.png

— You are receiving this because your review was requested. Reply to this email directly, view it on GitHub https://github.com/jazzband/icalevents/pull/83#discussion_r726492210, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAULT2S7OM2S6OL2LG5AWFLUGMUVNANCNFSM5FXOY5PQ .

-- Med vänlig hälsning Alexander Hultnér

eigenmannmartin commented 2 years ago

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