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 creating_integration_manifest.md #2125

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sofkaski
Copy link

Fix the syntax in the example of the requirement pointing to a public GitHub repository .

Proposed change

Fix the syntax in the example of the requirement pointing to a public GitHub repository and add explanation of the version.

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Removed stale or deprecated documentation

Additional information

  • This PR fixes or closes issue: fixes #
  • Link to relevant existing code or pull request:

Copy link
Member

@rytilahti rytilahti left a comment

Choose a reason for hiding this comment

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

hassfest doesn't seem to agree, are you sure this is correct syntax?

@sofkaski
Copy link
Author

sofkaski commented Mar 26, 2024

hassfest doesn't seem to agree, are you sure this is correct syntax?

I tried it successfully like this: "requirements": ["pysolarmanv5 @ git+https://github.com/sofkaski/pysolarmanv5.git@handle-timeout-in-data-receiver"].

I did not not look carefully the original text about the hash refrence. It does not seem valid for git (but for svn).

Now having a second look at the syntax it should be <project> @ git+https://github.com/<user>/<project>.git@<git ref> where <git ref> is any git reference: branch, tag, commit hash, ... . See PIP documentation.

@rytilahti your example error complains ...contains a space, but I bet that it is the hash reference.

So your case might be python-miio @ git+https://github.com/rytilahti/python-miio.git@0.6.0, given that you have a tag 0.6.0 pointing to the commit you want. Or just python-miio @ git+https://github.com/rytilahti/python-miio.git@master if you are happy with the tip of the branch.

I will fix the PR.

@sofkaski sofkaski force-pushed the patch-1 branch 2 times, most recently from e1ba5da to e4171a9 Compare March 29, 2024 13:25
@sofkaski
Copy link
Author

I will fix the PR.
I squashed my fix commit to the original one.

@rytilahti
Copy link
Member

rytilahti commented Mar 31, 2024

So what mine tries to do is to install the master branch unless version 0.6.0 is available/installed. I couldn't find any reference for this in the pypa/pip docs, so I'm not sure if it ever worked as described in the current docs.

Anyway, I just tried the exact string you gave on the current dev () resulting the same error. Could this be some version incompatibility?

* [ERROR] [REQUIREMENTS] Requirement "pysolarmanv5 @ git+https://github.com/sofkaski/pysolarmanv5.git@handle-timeout-in-data-receiver" contains a space

edit: If a git url is defined, the dependency will always be downloaded from git so my logic was wrong. Still unsure why I'm getting the "contains a space" error and how it should be fixed.

@sofkaski
Copy link
Author

sofkaski commented Apr 1, 2024

...I couldn't find any reference for this in the pypa/pip docs, so I'm not sure if it ever worked as described in the current docs.

I think so too. That is not a valid reference for Git, nor the semantics how it is stated to work. (It might work with Subversion version control?)

Anyway, I just tried the exact string you gave on the current dev () resulting the same error. Could this be some version incompatibility?

My environment where it works is:

  • HW: Raspberry Pi 4
  • Core 2024.3.3
  • Supervisor 2024.03.1
  • Operating System 12.1
  • Frontend 20240307.0

Fix the syntax in the example of the requirement pointing to a public GitHub repository .
@sofkaski
Copy link
Author

Rebased

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.

None yet

2 participants