Como incluir dados do pacote com setuptools / distribut?

Ao usar setuptools / distribut, não consigo fazer com que o instalador puxe nenhum package_dataarquivo. Tudo o que li diz que o seguinte é a maneira correta de fazer isso. Alguém pode aconselhar?

setup(
   name='myapp',
   packages=find_packages(),
   package_data={
      'myapp': ['data/*.txt'],
   },
   include_package_data=True,
   zip_safe=False,
   install_requires=['distribute'],
)

onde myapp/data/é o local dos arquivos de dados.

Percebo que essa é uma pergunta antiga, mas para as pessoas que estão chegando aqui pelo Google: package_dataé uma mentira humilde e suja . É usado apenas ao criar pacotes binários ( python setup.py bdist ...), mas não ao criar pacotes de origem ( python setup.py sdist ...). Isso é, obviamente, ridículo - seria de esperar que a construção de uma distribuição de origem resultasse em uma coleção de arquivos que poderiam ser enviados a outra pessoa para construir a distribuição binária.

De qualquer forma, o uso MANIFEST.infuncionará tanto para distribuições binárias quanto para fontes.

Eu apenas tive esse mesmo problema. A solução foi simplesmente remover include_package_data=True.

Depois de ler aqui , percebi que o include_package_dataobjetivo é incluir arquivos do controle de versão , em vez de apenas "incluir dados do pacote", como o nome indica. Dos documentos:

Os arquivos de dados [de include_package_data] devem estar sob o controle CVS ou Subversion

...

Se você deseja um controle mais refinado sobre quais arquivos estão incluídos (por exemplo, se você possui arquivos de documentação nos diretórios de pacotes e deseja excluí-los da instalação), também pode usar a package_datapalavra - chave.

Retirar esse argumento, corrigi-lo, o que é coincidentemente o motivo pelo qual ele também funcionou quando você mudou para o distutils, já que ele não aceita esse argumento.

Seguir a recomendação de @Joe para remover a include_package_data=Truelinha também funcionou para mim.

Para elaborar um pouco mais, não tenho nenhum MANIFEST.in arquivo. Eu uso o Git e não o CVS.

O repositório assume esse tipo de forma:

/myrepo
    - .git/
    - setup.py
    - myproject
        - __init__.py
        - some_mod
            - __init__.py
            - animals.py
            - rocks.py
        - config
            - __init__.py
            - settings.py
            - other_settings.special
            - cool.huh
            - other_settings.xml
        - words
            - __init__.py
            word_set.txt

setup.py:

from setuptools import setup, find_packages
import os.path

setup (
    name='myproject',
    version = "4.19",
    packages = find_packages(),  
    # package_dir={'mypkg': 'src/mypkg'},  # didnt use this.
    package_data = {
        # If any package contains *.txt or *.rst files, include them:
        '': ['*.txt', '*.xml', '*.special', '*.huh'],
    },

#
    # Oddly enough, include_package_data=True prevented package_data from working.
    # include_package_data=True, # Commented out.
    data_files=[
#               ('bitmaps', ['bm/b1.gif', 'bm/b2.gif']),
        ('/opt/local/myproject/etc', ['myproject/config/settings.py', 'myproject/config/other_settings.special']),
        ('/opt/local/myproject/etc', [os.path.join('myproject/config', 'cool.huh')]),
#
        ('/opt/local/myproject/etc', [os.path.join('myproject/config', 'other_settings.xml')]),
        ('/opt/local/myproject/data', [os.path.join('myproject/words', 'word_set.txt')]),
    ],

    install_requires=[ 'jsonschema',
        'logging', ],

     entry_points = {
        'console_scripts': [
            # Blah...
        ], },
)

Eu corro python setup.py sdistpara um distrib de origem (não tentei binário).

E quando dentro de um novo ambiente virtual, tenho um myproject-4.19.tar.gzarquivo e uso

(venv) pip install ~/myproject-4.19.tar.gz
...

E além de tudo que está sendo instalado no meu ambiente virtual site-packages, esses arquivos de dados especiais são instalados no /opt/local/myproject/datae /opt/local/myproject/etc.

include_package_data=True trabalhou para mim.

Se você usar git, lembre-se de incluir setuptools-gitno install_requires. Muito menos chato do que ter um Manifestou incluir todo o caminho package_data(no meu caso, é um aplicativo django com todo tipo de estática)

(colei o comentário que fiz, como o k3-rnc mencionou, é realmente útil como está)

Atualização : esta resposta é antiga e as informações não são mais válidas. Todas as configurações do setup.py devem ser usadas import setuptools. Adicionei uma resposta mais completa em https://stackoverflow.com/a/49501350/64313

Eu resolvi isso mudando para distutils. Parece que a distribuição está obsoleta e / ou quebrada.

from distutils.core import setup

setup(
   name='myapp',
   packages=['myapp'],
   package_data={
      'myapp': ['data/*.txt'],
   },
)

Pergunta antiga e ainda ... o gerenciamento de pacotes do python realmente deixa muito a desejar. Portanto, tive o caso de uso de instalar o pip localmente em um diretório especificado e fiquei surpreso que os caminhos package_data e data_files não funcionassem. Como não estava interessado em adicionar outro arquivo ao repositório, acabei aproveitando os arquivos data_files e setup.py --install-data; algo assim

pip install . --install-option="--install-data=$PWD/package" -t package  

Mover a pasta que contém os dados do pacote para a pasta do módulo resolveu o problema para mim.

Veja esta pergunta: MANIFEST.in ignorado em "python setup.py install" - nenhum arquivo de dados instalado?

Eu tive o mesmo problema por alguns dias, mas mesmo esse segmento não foi capaz de me ajudar, pois tudo estava confuso. Então, eu fiz minha pesquisa e encontrei a seguinte solução:

Basicamente, neste caso, você deve fazer:

from setuptools import setup

setup(
   name='myapp',
   packages=['myapp'],
   package_dir={'myapp':'myapp'}, # the one line where all the magic happens
   package_data={
      'myapp': ['data/*.txt'],
   },
)

A outra resposta completa do stackoverflow aqui

Basta remover a linha:

include_package_data=True,

do seu script de instalação e funcionará bem. (Testado agora com as ferramentas de instalação mais recentes.)

Usando o setup.cfg (setuptools ≥ 30.3.0)

A partir do setuptools 30.3.0 (lançado em 12/12/2016), você pode manter o setup.pytamanho muito pequeno e mover a configuração para um setup.cfgarquivo. Com essa abordagem, você pode colocar os dados do pacote em uma [options.package_data]seção:

[options.package_data]
* = *.txt, *.rst
hello = *.msg

Nesse caso, você setup.pypode ser tão curto quanto:

from setuptools import setup
setup()

Para obter mais informações, consulte a configuração usando os arquivos setup.cfg .

Há alguma conversa de depreciativosetup.cfg a favor de pyproject.tomlcomo proposto na PEP 518 , mas isso ainda é provisória a partir de 2020/02/21.