Блог

Я хочу, чтобы мои пользователи могли ссылаться на файл в моем пакете python (в частности, на файл docker-compose.yml) непосредственно из оболочки.

Я не смог найти способ получить только местоположение из pip show (и выделение «местоположения» из его вывода выглядит уродливо), поэтому мое текущее (несколько подробное) решение:

 docker compose -f $(python3 -c "import locust_plugins; print(locust_plugins.__path__[0])")/timescale/docker-compose.yml up
 

Есть ли лучший способ?

Редактировать: я решил это, установив команду-оболочку, которую я вызываю locust-compose как часть пакета. Не идеально, но оно выполняет свою работу:

 #!/bin/bash
module_location=$(python3 -c "import locust_plugins; print(locust_plugins.__path__[0])")
set -x
docker compose -f $module_location/timescale/docker-compose.yml "$@"
 

Большая часть поддержки, которая вам нужна для этого, находится в core setuptools suite.

Прежде всего, вам нужно убедиться, что файл данных включен в ваш пакет. В setup.cfg файле вы можете записать:

 [options.package_data]
timescale = docker-compose.yml
 

Теперь, если вы pip install . или pip wheel , это будет включать файл Compose как часть пакета Python.

Затем вы можете получить это в коде Python с помощью ResourceManager API:

 #!/usr/bin/env python3
# timescale/compose_path.py

import pkg_resources

if __name__ == '__main__':
  print(pkg_resources.resource_filename('timescale', 'docker-compose.yml'))
 

И, наконец, вы можете взять этот скрипт и сделать его сценарием точки входа setuptools (в отличие от концепции Docker с аналогичным именем), чтобы вы могли просто запустить его как одну команду.

 [options.entry_points]
console_scripts=
  timescale_compose_path = timescale:compose_path
 

Опять же, если вы pip install . находитесь в виртуальной среде, вы должны иметь возможность запустить timescale_compose_path и получить имя пути.

Выполнив все эти шаги, вы, наконец, можете запустить более простой

 docker-compose -f $(timescale_compose_path) up