Style: go to pyproject.toml

[manawasp]

Hello !

This PR is still in draft state.

While migrating to pyproject.toml I got issue with Sphinx and I was wondering if you want to keep Sphinx or If I could migrate to mkdocs with material theme ?

[wbarnha]

Thanks for the PR! I'm not a fan of how things are currently set up with Sphinx, so if switching to mkdocs makes things more readable, then sure! Let me look around at the changes to see if this is a good switch.

[manawasp]

Small update here @wbarnha :

Screenshot of the documentation:

Main page

References

1. I think the main content can be reworked in a later PR
2. The main documentation color can be changed as you please, here are default but we can set any hexa color.

You can serve documentation locally by running in new venv pip install -r requirements.txt then make serve-docs (or just mkdocs serve).

About this PR I still have:

• [ ] Validate command to build package
• [ ] Handle versioning correctly
• [ ] I don't know if Makefile is usefull or can be dropped I feel other python OSS prefer scripts/*
• [ ] Pass the pipeline :heavy_check_mark:

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 93.39%. Comparing base (5994429) to head (2273567). Report is 49 commits behind head on master.

:exclamation: Current head 2273567 differs from pull request most recent head 5e4bb4c. Consider uploading reports for the commit 5e4bb4c to get more accurate results

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #53 +/- ## ========================================== - Coverage 94.86% 93.39% -1.47% ========================================== Files 28 28 Lines 4031 3999 -32 Branches 449 614 +165 ========================================== - Hits 3824 3735 -89 - Misses 188 200 +12 - Partials 19 64 +45 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[manawasp]

No problem ! The work on the documentation is done. I have fixed the pipeline except on related pypy locally I can't reproduce the issue do you have an idea of the current issue ? @wbarnha

[wbarnha]

No problem ! The work on the documentation is done. I have fixed the pipeline except on related pypy locally I can't reproduce the issue do you have an idea of the current issue ? @wbarnha

PyPy tends to be a bit quirky. Let's add a test for PyPy 3.9 again as well, out of curiosity.

[wbarnha]

Oh, 3.9 failed as well.

[wbarnha]

I'll need a bit to revisit this, I'm in the middle of some things at the moment.

[manawasp]

I'll need a bit to revisit this, I'm in the middle of some things at the moment.

:ok_hand: in other case I will try to reproduce it this weekend locally via Docker maybe I will catch it :D

[manawasp]

Some news !

I started to backport changes little by little starting again from master and the pipeline is passing... So I will do it carely to catch to thing generating this issue.

https://github.com/manawasp/mode/pull/2/files

(And finally I will update changes here)

[manawasp]

Finally a green pipeline @wbarnha !! Look like related to this option --cov=mode.

I will rebase all commits to make something cleaner

[manawasp]

Thanks for your hard work, LGTM!

Your welcome! I didn't have time to rewrite commit but that's fine.

We should try to generate the new documentation but to do that we need to publish a new tag and a release, maybe a pre-release could work ? :thinking:

[manawasp]

@wbarnha little ping just to be sure you if you caught my previous message :D

[wbarnha]

Sorry! Got distracted by other projects. I was going to try to add a small feature before the next release. I agree, a pre-release could work. Let's do a beta release and see what happens.

[wbarnha]

Warning: Trusted Publishers allows publishing packages to PyPI from automated environments like GitHub Actions without needing to use username/password combinations or API tokens to authenticate with PyPI. Read more: https://docs.pypi.org/trusted-publishers
Checking dist/mode_streaming-0.3.5-py2.py3-none-any.whl: PASSED
Uploading distributions to https://upload.pypi.org/legacy/
Uploading mode_streaming-0.3.5-py2.py3-none-any.whl
25l
  0% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 0.0/115.1 kB • --:-- • ?
  0% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 0.0/115.1 kB • --:-- • ?
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 115.1/115.1 kB • 00:00 • 3.0 MB/s
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 115.1/115.1 kB • 00:00 • 3.0 MB/s
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 115.1/115.1 kB • 00:00 • 3.0 MB/s
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 115.1/115.1 kB • 00:00 • 3.0 MB/s
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 115.1/115.1 kB • 00:00 • 3.0 MB/s
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 115.1/115.1 kB • 00:00 • 3.0 MB/s
25hWARNING  Error during upload. Retry with the --verbose option for more details. 
ERROR    HTTPError: 400 Bad Request from https://upload.pypi.org/legacy/        
         File already exists. See https://pypi.org/help/#file-name-reuse for    
         more information.                                                      

Welp. Looks like something got broken. Did setuptools-scm get removed inadvertently?

[wbarnha]

This is weird, I don't recall my Github Pages deployment workflow being this janky. Apparently last deployment was in 2022. I don't remember what got altered...

[wbarnha]

There we go, it's on https://faust-streaming.github.io/mode/ now! I forgot about the workflow I configured for deploying pages. It's been a while and it's such a small, easy detail to overlook.

[wbarnha]

These pages are so nice. Thank you so much for your work, @manawasp!

[manawasp]

Was a pleasure ! Don't hesitate to ping me if you need some help here. I will be a bit busy the following weeks but I would like to give a shot on enabling mypy again.