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

Update plugin registration documentation about entry points #1920

Closed
Viicos opened this issue Feb 21, 2024 · 4 comments · Fixed by #1923
Closed

Update plugin registration documentation about entry points #1920

Viicos opened this issue Feb 21, 2024 · 4 comments · Fixed by #1923

Comments

@Viicos
Copy link
Contributor

Viicos commented Feb 21, 2024

describe the request

Hello,

The documentation currently states:

Flake8 relies on functionality provided by setuptools called Entry Points. These allow any package to register a plugin with Flake8 via that package’s setup.py file.

Any interest in having this part of the documentation updated to point to the Packaging user guide instead, so that people can be aware this is not a setuptools-only feature anymore?

(Without changing the setup.py example, I believe it is still up to date?)

@sigmavirus24
Copy link
Member

Sure. If merge a PR that updates that. For reference pkg_resources is also deprecated for a library in the standard library so it's worth mentioning that too

@pomponchik
Copy link

It could be great add something about setting up by pyproject.toml file.

@sigmavirus24
Copy link
Member

The packaging user guide already has examples for all types of package metadata config so that doesn't need to be replicated here

@Viicos
Copy link
Contributor Author

Viicos commented Feb 27, 2024

Yes I was thinking more about linking the packaging user guide, and explicitly stating "we give an example with setuptools (and setup.py) but this is now a standard blabla.."

Will probably have time to work on this by the end of the week

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 a pull request may close this issue.

3 participants