setup py examples

Question

After studying this page   http   docs python org distutils builtdist html  I am hoping to find some setup py files to study so as to make my own  with the goal of making a fedora rpm file    Could the s o  community point me towards some good examples

User · Answer

I recommend the setup py of the Python Packaging User Guide s example project   The Python Packaging User Guide  aims to be the authoritative resource on how to package  publish and install Python distributions using current tools

User · Answer

Here is the utility I wrote to generate a simple setup py file  template  with useful comments and links  I hope  it will be useful   Installation  sudo pip install setup-py-cli   Usage  To generate setup py file just type in the terminal   setup-py   Now setup py file should occur in the current directory    Generated setup py  from distutils core import setup from setuptools import find packages import os     User-friendly description from README md current directory   os path dirname os path abspath   file     try      with open os path join current directory   README md    encoding  utf-8   as f          long description   f read   except Exception      long description       setup        Name of the package     name  lt name of current directory gt          Packages to include into the distribution     packages find packages               Start with a small number and increase it with every change you make       https   semver org     version  1 0 0          Chose a license from here  https   help github com articles licensing-a-repository       For example  MIT     license            Short description of your library     description            Long description of your library     long description   long description      long description context type    text markdown          Your name     author             Your email     author email                 Either the link to your github or to your website     url            Link from which the project can be downloaded     download url            List of keyword arguments     keywords            List of packages to install with this one     install requires            https   pypi org classifiers      classifiers          Content of the generated setup py    automatically fulfilled package name based on the name of the current directory  some basic fields to fulfill  clarifying comments and links to useful resources  automatically inserted description from README md or an empty string if there is no README md    Here is the link to the repository  Fill free to enhance the solution

User · Answer

Minimal example  from setuptools import setup  find packages   setup      name  foo       version  1 0       packages find packages        More info in docs

User · Answer

READ THIS FIRST  https   packaging python org en latest current html     Installation Tool Recommendations         Use pip to install Python packages   from PyPI     Use virtualenv  or pyvenv to isolate application specific dependencies from a shared Python installation     Use pip wheel to create a cache of wheel distributions  for the purpose of   speeding up subsequent installations     If you   re looking for management of fully integrated cross-platform software stacks  consider buildout  primarily focused on the web development community  or Hashdist  or conda  both primarily focused on the scientific community            Packaging Tool Recommendations         Use setuptools to define projects and create Source Distributions    Use the bdist wheel setuptools extension available from the wheel project to create wheels  This is especially beneficial  if your project contains binary extensions    Use twine for uploading distributions to PyPI         This anwser has aged  and indeed there is a rescue plan for python packaging world called  wheels way  I qoute pythonwheels com here      What are wheels       Wheels are the new standard of python distribution   and are intended to replace eggs  Support is offered in pip    1 4 and   setuptools    0 8    Advantages of wheels   Faster installation for pure python and native C extension packages  Avoids arbitrary code execution for installation   Avoids setup py  Installation of a C extension does not require a compiler on Windows or OS X   Allows better caching for testing and continuous integration   Creates  pyc files as part of installation to ensure they match the python interpreter used   More consistent installs across platforms and machines    The full story of correct python packaging  and about wheels  is covered at packaging python org    conda way  For scientific computing  this is also recommended on packaging python org  see above  I would consider using CONDA packaging which can be seen as a 3rd party service build on top of PyPI and pip tools  It also works great on setting up your own version of binstar so I would imagine it can do the trick for sophisticated custom enterprise package management   Conda can be installed into a user folder  no super user permisssions  and works like magic with     conda install    and powerful virtual env expansion     eggs way  This option was related to python-distribute org and is largerly outdated  as well as the site  so let me point you to one of the ready to use yet compact setup py examples I like    A very practical example implementation of mixing scripts and single python files into setup py is giving here Even better one from hyperopt   This quote was taken from the guide on the state of setup py and still applies    setup py gone  distutils gone  distribute gone  pip and virtualenv here to stay  eggs     gone    I add one more point  from me    wheels    I would recommend to get some understanding of packaging-ecosystem  from the guide pointed by gotgenes  before attempting mindless copy-pasting   Most of examples out there in the Internet start with   from distutils core import setup   but this for example does not support building an egg python setup py bdist egg  as well as some other old features   which were available in  from setuptools import setup   And the reason is that they are deprecated   Now according to the guide      Warning      Please use the Distribute package rather than the Setuptools package   because there are problems in this package that can and will not be   fixed    deprecated setuptools are to be replaced by distutils2  which  will be part of the standard library in Python 3 3   I must say I liked setuptools and eggs and have not yet been completely convinced by convenience of distutils2  It requires  pip install Distutils2   and to install  python -m distutils2 run install     PS  Packaging never was trivial  one learns this by trying to develop a new one   so I assume a lot of things have gone for reason  I just hope this time it will be is done correctly

User · Answer

Look at this complete example https   github com marcindulak python-mycli of a small python package  It is based on packaging recommendations from https   packaging python org en latest distributing html  uses setup py with distutils and in addition shows how to create RPM and deb packages   The project s setup py is included below  see the repo for the full source       usr bin env python  import os import sys  from distutils core import setup  name    mycli   rootdir   os path abspath os path dirname   file        Restructured text project description read from file long description   open os path join rootdir   README md    read      Python 2 4 or later needed if sys version info  lt   2  4  0   final   0       raise SystemExit   Python 2 4 or later is required      Build a list of all project modules packages      for dirname  dirnames  filenames in os walk name           if    init   py  in filenames              packages append dirname replace             package dir    name  name     Data files used e g  in tests package data    name   os path join name   tests    prt txt        The current version number - MSI accepts only version X X X exec open os path join name   version py    read       Scripts scripts      for dirname  dirnames  filenames in os walk  scripts        for filename in filenames          if not filename endswith   bat                scripts append os path join dirname  filename      Provide bat executables in the tarball  always for Win  if  sdist  in sys argv or os name in   ce    nt        for s in scripts             scripts append s     bat      Data files  e g  doc  needs  directory  files-in-this-directory  tuples data files      for dirname  dirnames  filenames in os walk  doc            fileslist              for filename in filenames              fullname   os path join dirname  filename              fileslist append fullname          data files append   share     name         dirname  fileslist    setup name  python-    name        version version     PEP440       description  mycli - shows some argparse features         long description long description        url  https   github com marcindulak python-mycli         author  Marcin Dulak         author email  X Y Z com         license  ASL           https   pypi python org pypi  3Aaction list classifiers       classifiers              Development Status    1 - Planning              Environment    Console              License    OSI Approved    Apache Software License              Natural Language    English              Operating System    OS Independent              Programming Language    Python    2              Programming Language    Python    2 4              Programming Language    Python    2 5              Programming Language    Python    2 6              Programming Language    Python    2 7              Programming Language    Python    3              Programming Language    Python    3 2              Programming Language    Python    3 3              Programming Language    Python    3 4                  keywords  argparse distutils cli unittest RPM spec deb         packages packages        package dir package dir        package data package data        scripts scripts        data files data files            and and RPM spec file which more or less follows Fedora EPEL packaging guidelines may look like     Failsafe backport of Python2-macros for RHEL  lt   6     python sitelib   global python sitelib            python  -c  from distutils sysconfig import get python lib  print get python lib           python sitearch      global python sitearch           python  -c  from distutils sysconfig import get python lib  print get python lib 1          python version   global python version            python  -c  import sys  sys stdout write sys version  3            python2        global   python2           python       python2 sitelib      global python2 sitelib       python sitelib       python2 sitearch     global python2 sitearch      python sitearch       python2 version      global python2 version       python version        python2 minor version   define python2 minor version       python  -c  import sys   print sys version 2 3       global upstream name mycli   Name            python-  upstream name  Version         0 0 1 Release         1   dist  Summary         A Python program that demonstrates usage of argparse    el5 Group        Applications Scientific  License         ASL 2 0  URL             https   github com marcindulak   name  Source0         https   github com marcindulak   name    name -  version  tar gz     el5 BuildRoot      mktemp -ud    tmppath    name -  version -  release -XXXXXX   BuildArch       noarch   if 0   suse version  BuildRequires       python-devel  else BuildRequires       python2-devel  endif    description A Python program that demonstrates usage of argparse     prep  setup -qn   name -  version     build     python2  setup py build    install    el5 rm -rf  RPM BUILD ROOT      python2  setup py install --skip-build --prefix    prefix       --optimize 1 --root  RPM BUILD ROOT    check export PYTHONPATH  pwd  build lib export PATH  pwd  build scripts-  python2 version    PATH   if 0  python2 minor version   gt   7     python2  -m unittest discover -s   upstream name  tests -p    py   endif    clean    el5 rm -rf  RPM BUILD ROOT     files  doc LICENSE README md    bindir      python2 sitelib    upstream name      el5   python2 sitelib    egg-info     changelog   Wed Jan 14 2015 Marcin Dulak  lt X Y Z com gt  - 0 0 1-1 - initial version

User · Answer

You may find the HitchHiker s Guide to Packaging helpful  even though it is incomplete  I d start with the Quick Start tutorial  Try also just browsing through Python packages on the Python Package Index  Just download the tarball  unpack it  and have a look at the setup py file  Or even better  only bother looking through packages that list a public source code repository such as one hosted on GitHub or BitBucket  You re bound to run into one on the front page   My final suggestion is to just go for it and try making one  don t be afraid to fail  I really didn t understand it until I started making them myself  It s trivial to create a new package on PyPI and just as easy to remove it  So  create a dummy package and play around

User · Answer

Here you will find the simplest possible example of using distutils and setup py   https   docs python org 2 distutils introduction html distutils-simple-example  This assumes that all your code is in a single file and tells how to package a project containing a single module

User · Answer

Complete walkthrough of writing setup py scripts here   with some examples   If you d like a real-world example  I could point you towards the setup py scripts of a couple major projects  Django s is here  pyglet s is here  You can just browse the source of other projects for a file named setup py for more examples   These aren t simple examples  the tutorial link I gave has those  These are more complex  but also more practical

[python] setup.py examples?

Examples related to python

Examples related to rpm