feat: add `.tool-versions` and prompt for `poetry_version` by JaeAeich · Pull Request #37 · elixir-cloud-aai/cookiecutter-python

JaeAeich · 2024-11-16T10:39:49Z

Description

Fixes imp: support .tool-versions #27

Also prompt for poetry version, ref.

Checklist

Comments

Summary by Sourcery

Add support for managing the development environment with asdf.

New Features:

Add a new Makefile command asdfi to install tools based on the .tool-versions file.

Enhancements:

Introduce a .tool-versions file to specify tool versions.

Documentation:

Document the usage of asdf for managing project dependencies.

sourcery-ai · 2024-11-16T10:39:53Z

Reviewer's Guide by Sourcery

This pull request introduces support for managing project tools using asdf. It adds a .tool-versions file to specify tool versions, a new asdf-install Makefile target to install the specified tools, and updates the README with instructions for using asdf.

Sequence diagram for asdf tool installation process

sequenceDiagram
    participant D as Developer
    participant M as Makefile
    participant A as asdf
    participant TV as .tool-versions

    D->>M: make asdfi
    M->>TV: Read tool list
    M->>A: Add plugins for each tool
    A-->>M: Plugins added
    M->>A: asdf install
    A->>TV: Read tool versions
    A-->>M: Tools installed
    M-->>D: Installation complete

File-Level Changes

Change	Details	Files
Added support for asdf.	Added a section to the README explaining how to use asdf to manage the development environment. Created a new Makefile target `asdf-install` to install the tools specified in `.tool-versions`. Added a `.tool-versions` file to list the project's tool versions and their respective plugins to be managed by asdf	`{{ cookiecutter.project_name_dashed }}/README.md` `{{ cookiecutter.project_name_dashed }}/Makefile` `{{ cookiecutter.project_name_dashed }}/.tool-versions`

Assessment against linked issues

Issue	Objective	Addressed
#27	Streamline the setup process for developers by ensuring tool and language versions are easily available and version-controlled	✅
#27	Leverage asdf as a version manager to manage and install various tool versions needed for the project	✅
#27	Provide a consistent and flexible approach to tool version management across development environments	✅

Possibly linked issues

imp: support .tool-versions #27: The PR implements the solution proposed in the issue by adding a .tool-versions file and Makefile commands to install the specified tools.

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time. You can also use
this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @JaeAeich - I've reviewed your changes - here's some feedback:

Overall Comments:

The .tool-versions file appears to be empty. Please add the required tool version specifications to make this change functional.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

JaeAeich · 2024-11-16T10:54:15Z

JaeAeich · 2025-01-03T14:39:16Z

@sourcery-ai review

JaeAeich · 2025-01-03T14:39:31Z

@sourcery-ai summary

sourcery-ai

Hey @JaeAeich - I've reviewed your changes - here's some feedback:

Overall Comments:

The .tool-versions file appears to be empty in the diff. Please include its intended contents so we can review the tool specifications.
Consider adding documentation about the expected format and usage of the '# INSTALL:' commands in .tool-versions, since this is a custom implementation.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

JaeAeich · 2025-01-06T18:08:58Z

@uniqueg I do agree that maybe make asdfi might be way too hacky, if you think that we should let go of it, then I'll just remove make command and all the comments in .tools, with that I think this PR will be simplified quite alot, it just .tools-version with pythons version and docs.

What do you think? is that the way to go, or if its not hacky enough we can try to over engineer make asdfi and make it "secure" 😁 .

uniqueg · 2025-01-07T15:48:12Z

@uniqueg I do agree that maybe make asdfi might be way too hacky, if you think that we should let go of it, then I'll just remove make command and all the comments in .tools, with that I think this PR will be simplified quite alot, it just .tools-version with pythons version and docs.

What do you think? is that the way to go, or if its not hacky enough we can try to over engineer make asdfi and make it "secure" 😁 .

I would

for sure remove comments in .tool-versions
keep make asdfi and execute cat .tool-versions | cut -d' ' -f1 | grep "^[^\#]" | xargs -i asdf plugin add {} (as per Feature Idea: asdf install to also install plugins asdf-vm/asdf#276 (comment)), followed by asdf install

That way, make asdfi would install everything in .tool-versions - which I think is quite useful.

Now, for installing tools that are not covered by asdf plugins, just leave it up for each project to decide how to deal with those.

JaeAeich · 2025-01-07T16:08:27Z

@sourcery-ai review

JaeAeich · 2025-01-07T16:08:32Z

@sourcery-ai summary

sourcery-ai

Hey @JaeAeich - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

uniqueg

Please prompt the user for the desired Poetry version, just like you do for the Python version.

add asdf install

a4c531c

sourcery-ai Bot reviewed Nov 16, 2024

View reviewed changes

sourcery-ai Bot reviewed Jan 3, 2025

View reviewed changes

JaeAeich added 2 commits January 3, 2025 22:18

add poetry install instructions to .tools

9224b1e

chore: add docs

ebb48f0

JaeAeich requested a review from uniqueg January 6, 2025 15:15

Merge branch 'main' into asdf

21b719c

uniqueg requested changes Jan 6, 2025

View reviewed changes

JaeAeich added 2 commits January 7, 2025 21:33

remove asdf comments

b8f598c

merge

97adc3a

JaeAeich commented Jan 7, 2025

View reviewed changes

Comment thread {{ cookiecutter.project_name_dashed }}/.tool-versions Outdated

sourcery-ai Bot reviewed Jan 7, 2025

View reviewed changes

JaeAeich requested a review from uniqueg January 7, 2025 16:09

uniqueg requested changes Jan 8, 2025

View reviewed changes

Comment thread {{ cookiecutter.project_name_dashed }}/README.md

JaeAeich and others added 2 commits January 9, 2025 18:30

update readme and install asdf in dev container

160302b

Merge branch 'main' into asdf

df5ce39

JaeAeich requested a review from uniqueg January 9, 2025 13:22

uniqueg requested changes Jan 9, 2025

View reviewed changes

Comment thread {{ cookiecutter.project_name_dashed }}/.tool-versions Outdated

JaeAeich added 2 commits January 14, 2025 22:04

chore: poetry version

a354857

chore: minor

22cd2f9

JaeAeich changed the title ~~feat: add .tool-versions~~ feat: add .tool-versions and prompt for poetry_version Jan 14, 2025

Merge branch 'main' into asdf

3e0e3d7

JaeAeich requested a review from uniqueg January 14, 2025 16:38

uniqueg approved these changes Mar 5, 2025

View reviewed changes

Merge branch 'main' into asdf

875b1ca

JaeAeich merged commit 89c9e90 into main Mar 10, 2025

JaeAeich deleted the asdf branch March 10, 2025 04:57

Conversation

JaeAeich commented Nov 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Comments

Summary by Sourcery

Uh oh!

sourcery-ai Bot commented Nov 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Sequence diagram for asdf tool installation process

File-Level Changes

Assessment against linked issues

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

JaeAeich commented Nov 16, 2024

Uh oh!

JaeAeich commented Jan 3, 2025

Uh oh!

JaeAeich commented Jan 3, 2025

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JaeAeich commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

uniqueg commented Jan 7, 2025

Uh oh!

JaeAeich commented Jan 7, 2025

Uh oh!

JaeAeich commented Jan 7, 2025

Uh oh!

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

uniqueg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

JaeAeich commented Nov 16, 2024 •

edited

Loading

sourcery-ai Bot commented Nov 16, 2024 •

edited

Loading

JaeAeich commented Jan 6, 2025 •

edited

Loading