Using poetry with private git repo as dependencies

[k4ml]

Firstly, let's create new poetry project:-

mkdir withpoetry
cd withpoetry
poetry init

This command will guide you through creating your pyproject.toml config.

Package name [withpoetry]:  
Version [0.1.0]:  
Description []:  
Author [Kamal Mustafa <[email protected]>, n to skip]:  
License []:  
Compatible Python versions [^3.10]:  

Would you like to define your main dependencies interactively? (yes/no) [yes] 
You can specify a package in the following forms:
  - A single name (requests): this will search for matches on PyPI
  - A name and a constraint (requests@^2.23.0)
  - A git url (git+https://github.com/python-poetry/poetry.git)
  - A git url with a revision (git+https://github.com/python-poetry/poetry.git#develop)
  - A file path (../my-package/my-package.whl)
  - A directory (../my-package/)
  - A url (https://example.com/packages/my-package-0.1.0.tar.gz)

Package to add or search for (leave blank to skip): django
Found 20 packages matching django
Showing the first 10 matches

Enter package # to add, or the complete package name if it is not listed []:
 [ 0] Django
 [ 1] django-503
 [ 2] django-filebrowser-django13
 [ 3] django-tracking-analyzer-django2
 [ 4] django-jchart-django3-uvm
 [ 5] django-totalsum-admin-django3
 [ 6] django-debug-toolbar-django13
 [ 7] django-suit-redactor-django2
 [ 8] django-django_csv_exports
 [ 9] django-thumborize
 [ 10] 
 > 0
Enter the version constraint to require (or leave blank to use the latest version): 
Using version ^4.1.4 for Django

Add a package (leave blank to skip): 

Would you like to define your development dependencies interactively? (yes/no) [yes] no
Generated file

[tool.poetry]
name = "withpoetry"
version = "0.1.0"
description = ""
authors = ["Kamal Mustafa <[email protected]>"]
readme = "README.md"

[tool.poetry.dependencies]
python = "^3.10"
Django = "^4.1.4"


[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"


Do you confirm generation? (yes/no) [yes]

This will give us file named pyproject.toml in current directory. Now let's try to add a private git repo as dependencies.

poetry add -e [email protected]:lalokalabs/drafu.git

Could not parse version constraint: github.com:lalokalabs/drafu.git

Ughh, what give ... Let's check the command's help:-

git add --help
...
...
You can specify a package in the following forms:
    - A single name (requests)
    - A name and a constraint (requests@^2.23.0)
    - A git url (git+https://github.com/python-poetry/poetry.git)
    - A git url with a revision (git+https://github.com/python-poetry/poetry.git#develop)
    - A git SSH url (git+ssh://github.com/python-poetry/poetry.git)
    - A git SSH url with a revision (git+ssh://github.com/python-poetry/poetry.git#develop)
    - A file path (../my-package/my-package.whl)
    - A directory (../my-package/)
    - A url (https://example.com/packages/my-package-0.1.0.tar.gz)

Aaah, ok. Need to use the git+ssh form.

poetry add -e git+ssh://github.com/lalokalabs/drafu.git

[email protected]: Permission denied (publickey).

This also doesn't work:-

poetry add -e git+ssh://[email protected]/lalokalabs/drafu.git

[email protected]: Permission denied (publickey).

Oh, wait. Github url should use git as username. So:-

poetry add -e git+ssh://[email protected]/lalokalabs/drafu.git

Updating dependencies
Resolving dependencies... Downloading https://files.pythonhosted.org/packages/85/ac/92f998fc52a7Resolving dependencies... Downloading https://files.pythonhosted.org/packages/d1/d6/3965ed04c630Resolving dependencies... (8.9s)
...

Now it installing.

[k4ml]

Next, we want to check where our repo get installed.

poetry run python
Python 3.10.7 (main, Sep  6 2022, 21:22:27) [GCC 12.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import drafu
>>> drafu
<module 'drafu' from '/home/kamal-kde/.cache/pypoetry/virtualenvs/withpoetry-XfX7q0IL-py3.10/src/drafu/drafu/__init__.py'>
>>>

Notice that before I'm using git add -e flag? That means to install it as editable install. So let's check if it really is.

cd /home/kamal-kde/.cache/pypoetry/virtualenvs/withpoetry-XfX7q0IL-py3.10/src/drafu/
ls
drafu  poetry.lock  pyproject.toml  setup.py

git status
On branch master
nothing to commit, working tree clean

Ok, it's a git repo, so it's "editable". But will the changes to that repo will be preserved? I made some changes and then run poetry update. Guess what, the changes is gone!

[k4ml]

So if you plan to use poetry for multi-repos project, something like buildout's mr.developer, you can't.