使用setup.py将python项目安装为systemd服务

时间：2016-02-17 05:40:43

标签： python ubuntu setup.py systemd

我有一个python项目，我希望能够使用python setup.py install之类的东西来安装它，以便安装自动创建一个systemd服务。

我遇到了一些麻烦，很可能是正确设置路径或导入。

  

我的环境：

     
      
  • Ubuntu 15.04
    •   
  • Python 2.7（虽然它也很适合在py3中工作）。
    •   

项目结构：

+ top-folder
  + super_project
    + folder1
      __init__.py
      file1.py
    + folder2
      __init__.py
      file2.py
    __init__.py
    main.py
  setup.py
  setup.cfg

setup.py：

from setuptools.command.install import install
from setuptools import setup, find_packages
import subprocess
import os


class CustomInstallCommand(install):

  def run(self):
    install.run(self)
    current_dir_path = os.path.dirname(os.path.realpath(__file__))
    create_service_script_path = os.path.join(current_dir_path, 'super_project', 'install_scripts', 'create_service.sh')
    subprocess.check_output([create_service_script_path])

setup(
  name='super-project',
  author='Myself',
  version='0.0.1',
  description='My Description',
  packages=find_packages(exclude=['contrib', 'docs']),
  # this will create the /usr/local/bin/super-project entrypoint script
  entry_points={
    'console_scripts': [
      'super-project = super_project.main:main'
    ]
  },
  cmdclass={'install': CustomInstallCommand}
)

main.py 

from super_project.folder1.file1 import Class1
from super_project.folder2.file2 import Class2
import logging


def main():
  logging.info('Executing super-project...')
  (...)
  logging.info('super-project execution finished.')

if __name__ == '__main__':
  main()

setup.cfg 

[bdist_wheel]
universal=1

create_service.sh（或多或少）：

SYSTEMD_SCRIPT_DIR=$( cd  $(dirname "${BASH_SOURCE:=$0}") && pwd)
cp -f "$SYSTEMD_SCRIPT_DIR/super-project.service" /lib/systemd/system
chown root:root /lib/systemd/system/super-project.service

systemctl daemon-reload
systemctl enable super-project.service

超project.service 

[Unit]
Description=Super Description

[Service]
Type=simple
ExecStart=/usr/local/bin/super-service
Restart=always

[Install]
WantedBy=multi-user.target

安装包会生成以下输出：

$ sudo python setup.py install --record files.txt
running install
running build
running build_py
copying super_project/main.py - build/lib.linux-x86_64-2.7/super_project
running install_lib
copying build/lib.linux-x86_64-2.7/super_project/__init__.py - /usr/local/lib/python2.7/dist-packages/super_project
copying build/lib.linux-x86_64-2.7/super_project/main.py - /usr/local/lib/python2.7/dist-packages/super_project
copying build/lib.linux-x86_64-2.7/super_project/db/__init__.py - /usr/local/lib/python2.7/dist-packages/super_project/db
copying build/lib.linux-x86_64-2.7/super_project/db/db_gateway.py - /usr/local/lib/python2.7/dist-packages/super_project/db
(...)
byte-compiling /usr/local/lib/python2.7/dist-packages/super_project/__init__.py to
__init__.pyc
byte-compiling /usr/local/lib/python2.7/dist-packages/super_project/main.py to
main.pyc
byte-compiling /usr/local/lib/python2.7/dist-packages/super_project/db/__init__.py to
__init__.pyc
byte-compiling /usr/local/lib/python2.7/dist-packages/super_project/db/db_gateway.py
to db_gateway.pyc
(...)
running install_egg_info
running egg_info
writing requirements to super_project.egg-info/requires.txt
writing super_project.egg-info/PKG-INFO
writing top-level names to super_project.egg-info/top_level.txt
writing dependency_links to super_project.egg-info/dependency_links.txt
writing entry points to super_project.egg-info/entry_points.txt
reading manifest file 'super_project.egg-info/SOURCES.txt'
writing manifest file 'super_project.egg-info/SOURCES.txt'
Copying super_project.egg-info to /usr/local/lib/python2.7/dist-packages/super_project-0.0.1.egg-info
running install_scripts
Installing ai-scenario-qa script to /usr/local/bin
writing list of installed files to 'files.txt'

{/ 1}}文件在/ usr / local / bin中创建：

super-project

安装似乎很成功，但是：

#!/usr/bin/python
# EASY-INSTALL-ENTRY-SCRIPT: 'super-project==0.0.1','console_scripts','super-project'
__requires__ = 'super-project==0.0.1'
import sys
from pkg_resources import load_entry_point

if __name__ == '__main__':
    sys.exit(
        load_entry_point('super-project==0.0.1', 'console_scripts', 'super-project')()
    )

我可以在/ var / log / syslog中看到错误：

$ systemctl status super-project.service
● super-project.service
   Loaded: not-found (Reason: No such file or directory)
   Active: inactive (dead)

可以看出，无法找到模块 Feb 16 20:48:34 systemd[1]: Starting Super Description... Feb 16 20:48:34 super-project[22517]: Traceback (most recent call last): Feb 16 20:48:34 super-project[22517]: File "/usr/local/bin/super-project", line 9, in <module Feb 16 20:48:34 super-project[22517]: load_entry_point('super-project==0.0.1', 'console_scripts', 'super-project')() Feb 16 20:48:34 super-project[22517]: File "/usr/lib/python2.7/dist-packages/pkg_resources/__init__.py", line 521, in load_entry_point Feb 16 20:48:34 super-project[22517]: return get_distribution(dist).load_entry_point(group, name) Feb 16 20:48:34 super-project[22517]: File "/usr/lib/python2.7/dist-packages/pkg_resources/__init__.py", line 2632, in load_entry_point Feb 16 20:48:34 super-project[22517]: return ep.load() Feb 16 20:48:34 super-project[22517]: File "/usr/lib/python2.7/dist-packages/pkg_resources/__init__.py", line 2312, in load Feb 16 20:48:34 super-project[22517]: return self.resolve() Feb 16 20:48:34 super-project[22517]: File "/usr/lib/python2.7/dist-packages/pkg_resources/__init__.py", line 2318, in resolve Feb 16 20:48:34 super-project[22517]: module = __import__(self.module_name, fromlist=['__name__'], level=0) Feb 16 20:48:34 super-project[22517]: ImportError: No module named main Feb 16 20:48:34 systemd[1]: super-project.service: main process exited, code=exited, status=1/FLURE Feb 16 20:48:34 systemd[1]: Unit super-project.service entered fled state. Feb 16 20:48:34 systemd[1]: super-project.service failed. Feb 16 20:48:34 systemd[1]: super-project.service holdoff time over, scheduling restart. Feb 16 20:48:34 systemd[1]: start request repeated too quickly for super-project.service Feb 16 20:48:34 systemd[1]: Failed to start Super Description. Feb 16 20:48:34 systemd[1]: Unit super-project.service entered fled state. Feb 16 20:48:34 systemd[1]: super-project.service failed. 。这是主要问题。

更改代码/ conf时，我删除了超级项目/服务，如下所示：

main

另一方面：

  • 如果我从$ sudo systemctl disable super-project.service $ sudo rm -f /lib/systemd/system/super-project.service $ sudo systemctl daemon-reload $ su # cat files.txt | xargs rm -r 执行$ super-project，脚本会正确启动（没有导入异常），但无法读取配置文件（很可能是因为相对/绝对路径问题）。
  • 如果我从/usr/local/bin/（包含项目代码/文件的文件夹）执行$ super-project，则脚本运行完美

我错过了什么？我花了很多时间搜索问题所在。似乎在top-folder目录中正确设置了包，并且在执行设置后正确创建了所有服务文件。

我已经阅读了有关使用dist-packages的内容，但我不确定是否必须将其添加到我的main.py（它不起作用）或我项目中的所有文件。

3 个答案:

答案 0 :(得分：1)

请确保您的应用程序可以从其他目录执行，这似乎是一个经典案例，您假设当前目录是启动脚本所在的位置。

它与systemd无关。还尝试从登录shell外部执行start命令（您的.profile不会被服务加载）。

答案 1 :(得分：0)

您收到ImportError，因为有问题的模块不在sys.path中，或者由于某些文件系统权限而无法访问。
这是一个用于检查给定分发，组和名称的文件系统权限的脚本。

chk_perm.py 

from pkg_resources import get_distribution
import os
import sys

dist, group, name = sys.argv[1:]
dist = get_distribution(dist)
location = dist.location
einfo = dist.get_entry_info(group, name)
if not einfo:
    print('No such group "{}" or name "{}"'.format(group, name))
    sys.exit(1)
m_name = einfo.module_name
path = format(os.path.join(location, *m_name.split('.')))
path = path if os.access(path, os.F_OK) else '{}.py'.format(path)
print('If path "{}" exists: {}'.format(path, os.access(path, os.F_OK) if path.endswith('.py') else True))
print('If path "{}" readable: {}'.format(path, os.access(path, os.R_OK)))

测试; 

$ python chk_perm.py setuptools console_scripts easy_install
If path "lib/python2.7/site-packages/setuptools/command/easy_install.py" exists: True
If path "lib/python2.7/site-packages/setuptools/command/easy_install.py" readable: True

$ foo
Traceback (most recent call last):
  File "bin/foo", line 9, in <module>
    load_entry_point('mypkg==0.0.4', 'console_scripts', 'foo')()
  File "lib/python2.7/site-packages/pkg_resources/__init__.py", line 549, in load_entry_point
    return get_distribution(dist).load_entry_point(group, name)
  File "lib/python2.7/site-packages/pkg_resources/__init__.py", line 2542, in load_entry_point
    return ep.load()
  File "lib/python2.7/site-packages/pkg_resources/__init__.py", line 2202, in load
    return self.resolve()
  File "lib/python2.7/site-packages/pkg_resources/__init__.py", line 2208, in resolve
    module = __import__(self.module_name, fromlist=['__name__'], level=0)
ImportError: No module named main

$ python chk_perm.py mypkg console_scripts foo
If path "lib/python2.7/site-packages/pkg/main.py" exists: True
If path "lib/python2.7/site-packages/pkg/main.py" readable: False

$ ls -l lib/python2.7/site-packages/pkg/main.py 
-rw-rw---- 1 root root 104 Mar  6 22:52 lib/python2.7/site-packages/pkg/main.py

$ sudo chmod o+r lib/python2.7/site-packages/pkg/main.py
$ ls -l lib/python2.7/site-packages/pkg/main.py 
-rw-rw-r-- 1 root root 104 Mar  6 22:52 lib/python2.7/site-packages/pkg/main.py

$ python chk_perm.py mypkg console_scripts foo
If path "lib/python2.7/site-packages/pkg/main.py" exists: True
If path "lib/python2.7/site-packages/pkg/main.py" readable: True

$ foo
App is running

答案 2 :(得分：0)

对我所有的项目最好使用一种可以做的最好的方法，就是对如何做做一个简短的描述。
警告：我只在linux上工作，我对装有玻璃或圆形水果的墙壁上的开口一无所知...：）

创建类似
的脚本 文件：scripts / super-project.bash_completion 

eval "$(register-python-argcomplete super-project)"

然后将一个包含项添加到MANIFEST.in 

include scripts/super-project.bash_completion

通常，“ super-project”文件（不带ext）是这样的入口点：
文件：bin / super-project 

#!/usr/bin/env python2.7
from super_project.main import main

if __name__ == '__main__':
    main()
else:
    raise NotImplementedError

我想这个bin / super-project可以用来加载入口点。

致谢。

相关问题
最新问题