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