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

Issue 36: Implement entrypoint support #46

Merged
merged 22 commits into from
Aug 12, 2023
Merged

Conversation

sjlongland
Copy link
Collaborator

@sjlongland sjlongland commented Aug 5, 2023

This implements the entry-point support. (Closes issue #36)

@sjlongland sjlongland added enhancement New feature or request good first issue Good for newcomers setuptools-fields Fields in the pyproject data structure that this project needs to support labels Aug 5, 2023
@sjlongland sjlongland added this to the Initial release milestone Aug 5, 2023
Copy link
Owner

@diazona diazona left a comment

Choose a reason for hiding this comment

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

I wrote up some feedback before realizing you had this marked as a draft, whoops 😅 but I figured I might as well post it rather than discarding it. Feel free to ignore all my comments for a while if you're still working on this. And as always, all open to discussion.

src/setuptools_pyproject_migration/__init__.py Outdated Show resolved Hide resolved
src/setuptools_pyproject_migration/__init__.py Outdated Show resolved Hide resolved
src/setuptools_pyproject_migration/__init__.py Outdated Show resolved Hide resolved
src/setuptools_pyproject_migration/__init__.py Outdated Show resolved Hide resolved
src/setuptools_pyproject_migration/__init__.py Outdated Show resolved Hide resolved
src/setuptools_pyproject_migration/__init__.py Outdated Show resolved Hide resolved
@sjlongland sjlongland force-pushed the feature/i36-entrypoints branch from ee0bcb2 to 18353c4 Compare August 6, 2023 01:14
@sjlongland sjlongland marked this pull request as ready for review August 6, 2023 04:14
@sjlongland sjlongland force-pushed the feature/i36-entrypoints branch from 465311c to 75b605d Compare August 6, 2023 04:23
src/setuptools_pyproject_migration/__init__.py Outdated Show resolved Hide resolved
src/setuptools_pyproject_migration/__init__.py Outdated Show resolved Hide resolved
src/setuptools_pyproject_migration/__init__.py Outdated Show resolved Hide resolved
src/setuptools_pyproject_migration/__init__.py Outdated Show resolved Hide resolved
src/setuptools_pyproject_migration/__init__.py Outdated Show resolved Hide resolved
tests/test_entrypoint.py Outdated Show resolved Hide resolved
tests/test_entrypoint.py Outdated Show resolved Hide resolved
tests/test_entrypoint.py Outdated Show resolved Hide resolved
tests/test_entrypoint.py Outdated Show resolved Hide resolved
@diazona diazona linked an issue Aug 7, 2023 that may be closed by this pull request
@diazona
Copy link
Owner

diazona commented Aug 7, 2023

I think it might be necessary to include "Closes #36" in the issue description to get the issue to be automatically closed when this is merged. (Putting it in a comment doesn't seem to be enough)

@sjlongland sjlongland force-pushed the feature/i36-entrypoints branch from 75b605d to 8c25833 Compare August 11, 2023 09:18
@sjlongland sjlongland enabled auto-merge August 11, 2023 09:46
@diazona
Copy link
Owner

diazona commented Aug 11, 2023

Don't forget to resolve the merge conflicts. (I don't care whether you do it by rebasing or by merging main into your branch)

Feel free to resolve comment threads that have been addressed or are otherwise no longer needed if you like, but I will also come back to this sometime in the next day or so and review all the comment threads, resolving as needed. Right now I only had time for a quick peek. (I'm supposed to be at work lol, but it's quiet at the moment)

It didn't like the fact I was trying to save some copy-paste work.
We're now generating a section for this metadata.  While we're here, add
scripts and GUI scripts to that metadata.

(Rebased on 8f007bc)
We're not calling or accessing any instance methods.  While we're here,
fill out the documentation a little more.
This is needed to be able to use a sequence of them to construct a
`dict` using the `dict` constructor, as the latter does not like getting
a sequence of `dict`s as input.
This may generate an empty `dict` if `setuptools` gives us an empty
`list` as input, but 99% of the time we should be fine.  We'll re-visit
this if it becomes a problem later.
Use "doctests" style to document the function's behaviour, with more
formal definitions below.
We don't actually need to expose them on the class itself since they
reference none of the class instance fields.  Probably makes more sense
to make these discrete functions.
@sjlongland sjlongland force-pushed the feature/i36-entrypoints branch from f6a99c5 to 1ffe28f Compare August 11, 2023 23:17
Since this isn't a public-facing API, it probably makes more sense to
make this a doc test.  It also helps document it.
The only time this is spelt entry-points, is in the TOML output.
In documentation, it is "entry points" (space).  In code, we'll use
`entry_points` (underscore) -- _unless_ it's the TOML output.
@sjlongland sjlongland force-pushed the feature/i36-entrypoints branch from a6645e3 to 13856b6 Compare August 11, 2023 23:40
@sjlongland sjlongland merged commit 2a73536 into main Aug 12, 2023
@sjlongland sjlongland deleted the feature/i36-entrypoints branch August 12, 2023 05:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers setuptools-fields Fields in the pyproject data structure that this project needs to support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support entry points
2 participants