Specifying GitHub Source in requirements.txt

To integrate a library installed from a GitHub repository into your dependencies, modify your requirements.txt file as follows:

For GitHub repositories, omit the "package==version" naming convention. Instead, use the following format:

package-name @ git git://github.com/owner/repo@reference

where "reference" can be:

• Commit hash: package-name @ git https://github.com/owner/repo@41b95ec
• Branch name: package-name @ git https://github.com/owner/repo@main
• Tag: package-name @ git https://github.com/owner/[email protected]
• Release: package-name @ git https://github.com/owner/repo@releases/tag/v3.7.1

Example:

To update the "package-two" dependency with a GitHub repository, use one of the following configurations in your requirements.txt:

package-two @ git https://github.com/owner/repo@41b95ec
package-two @ git https://github.com/owner/repo@main
package-two @ git https://github.com/owner/[email protected]
package-two @ git https://github.com/owner/repo@releases/tag/v3.7.1

Note: In some pip versions, update the package version in the package's setup.py to avoid assuming the requirement is already met.