Ravenports generated: 08 Jan 2019 16:45
[ravenports.git] / bucket_89 / python-setuptools_git
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-setuptools_git
4 VERSION=                1.2
5 KEYWORDS=               python devel
6 VARIANTS=               py27 py36 py37
7 SDESC[py36]=            Setuptools revision control system plugin  (PY 36)
8 SDESC[py37]=            Setuptools revision control system plugin  (PY 37)
9 SDESC[py27]=            Setuptools revision control system plugin  (PY 27)
10 HOMEPAGE=               https://github.com/msabramo/setuptools-git
11 CONTACT=                Python_Automaton[python@ironwolf.systems]
12
13 DOWNLOAD_GROUPS=        main
14 SITES[main]=            PYPI/s/setuptools_git
15 DISTFILE[1]=            setuptools-git-1.2.tar.gz:main
16 DF_INDEX=               1
17 SPKGS[py36]=            single
18 SPKGS[py37]=            single
19 SPKGS[py27]=            single
20
21 OPTIONS_AVAILABLE=      PY27 PY36 PY37
22 OPTIONS_STANDARD=       none
23 VOPTS[py36]=            PY27=OFF PY36=ON PY37=OFF
24 VOPTS[py37]=            PY27=OFF PY36=OFF PY37=ON
25 VOPTS[py27]=            PY27=ON PY36=OFF PY37=OFF
26
27 DISTNAME=               setuptools-git-1.2
28
29 GENERATED=              yes
30
31 [PY36].USES_ON=                         python:py36
32
33 [PY37].USES_ON=                         python:py37
34
35 [PY27].USES_ON=                         python:py27
36
37 [FILE:2862:descriptions/desc.single]
38 About
39 -----
40
41 This is a plugin for setuptools that enables git integration. Once
42 installed, Setuptools can be told to include in a package distribution
43 all the files tracked by git. This is an alternative to explicit
44 inclusion specifications with ``MANIFEST.in``.
45
46 A package distribution here refers to a package that you create using
47 setup.py, for example::
48
49   $> python setup.py sdist
50   $> python setup.py bdist_rpm
51   $> python setup.py bdist_egg
52
53 This package was formerly known as gitlsfiles. The name change is the
54 result of an effort by the setuptools plugin developers to provide a
55 uniform naming convention.
56
57
58 Installation
59 ------------
60
61 With easy_install::
62
63   $> easy_install setuptools_git
64
65 Alternative manual installation::
66
67   $> tar -zxvf setuptools_git-X.Y.Z.tar.gz
68   $> cd setuptools_git-X.Y.Z
69   $> python setup.py install
70
71 Where X.Y.Z is a version number.
72
73
74
75 Usage
76 -----
77
78 To activate this plugin, you must first package your python module
79 with ``setup.py`` and use setuptools. The former is well documented in
80 the `distutils manual <http://docs.python.org/dist/dist.html>`_.
81
82 To use setuptools instead of distutils, just edit ``setup.py`` and
83 change:
84
85 .. code-block:: python
86
87   from distutils.core import setup
88
89 to:
90
91 .. code-block:: python
92
93   from setuptools import setup, find_packages
94
95 When Setuptools builds a source package, it always includes all files
96 tracked by your revision control system, if it knows how to learn what
97 those files are.
98
99 When Setuptools builds a binary package, you can ask it to include all
100 files tracked by your revision control system, by adding these argument
101 to your invocation of `setup()`:
102
103 .. code-block:: python
104
105   setup(...,
106         packages=find_packages(),
107         include_package_data=True,
108         ...)
109
110 which will detect that a directory is a package if it contains a
111 ``__init__.py`` file.  Alternatively, you can do without ``__init__.py``
112 files and tell Setuptools explicitly which packages to process:
113
114 .. code-block:: python
115
116   setup(...,
117         packages=["a_package", "another_one"],
118         include_package_data=True,
119         ...)
120
121 This plugin lets setuptools know what files are tracked by your git
122 revision control tool.  Setuptools ships with support for cvs and
123 subversion.  Other plugins like this one are available for bzr, darcs,
124 monotone, mercurial, and many others.
125
126 It might happen that you track files with your revision control system
127 that you don't want to include in your packages.  In that case, you
128 can prevent setuptools from packaging those files with a directive in
129 your ``MANIFEST.in``, for example::
130
131   exclude .gitignore
132   recursive-exclude images *.xcf *.blend
133
134 In this example, we prevent setuptools from packaging ``.gitignore`` and
135 the Gimp and Blender source files found under the ``images`` directory.
136
137 Files to exclude from the package can also be listed in the `setup()`
138
139
140 [FILE:104:distinfo]
141 ff64136da01aabba76ae88b050e7197918d8b2139ccbf6144e14d472b9c40445        10546 setuptools-git-1.2.tar.gz
142