Skip to content

docs(readme): add block code type#48

Merged
wbarnha merged 2 commits into
faust-streaming:masterfrom
manawasp:docs/update-readme-code-synthax
Feb 22, 2024
Merged

docs(readme): add block code type#48
wbarnha merged 2 commits into
faust-streaming:masterfrom
manawasp:docs/update-readme-code-synthax

Conversation

@manawasp

Copy link
Copy Markdown

Hello,

Just submitting this small MR to fix syntax highlight color on README

@wbarnha

wbarnha commented Feb 22, 2024

Copy link
Copy Markdown
Member

Looks like linting got updated. 🤦‍♂️ Probably the same issue as faust-streaming/faust#609 from the looks of it.

@manawasp

Copy link
Copy Markdown
Author

Looks like linting got updated. 🤦‍♂️ Probably the same issue as faust-streaming/faust#609 from the looks of it.

I just opened another to fix this, I will rebase after merged to master.

I would like to polish some internals here so, I would like to have your opinion:

  • Use ruff for linting and formating
  • Switch to pyproject.toml
  • Bump minimal project to 3.8+ as py3.7 support ended
  • Remove some README information about py2 et py<=3.7
  • See if I can do something about type hint
  • Use poetry or hatch to build and manage dependencies (Any preference?)

@wbarnha

wbarnha commented Feb 22, 2024

Copy link
Copy Markdown
Member

I've typically preferred using pip-compile to freeze dependencies, but I can still be sold on using poetry if need-be. I should go back and re-read from documentation to see if my opinion can be changed. My main argument against it is that there are some cases where dependency management can be a pain when trying to support new Python versions or projects, however that happens so infrequently that it may be trivial.

@wbarnha wbarnha left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for your contributions! LGTM!

@wbarnha wbarnha merged commit 5439ba9 into faust-streaming:master Feb 22, 2024
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