Ravenports generated: 08 Mar 2024 17:01
[ravenports.git] / bucket_F8 / 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
6 VARIANTS=               v11 v12
7 SDESC[v11]=             Revision control system plugin for Git (3.11)
8 SDESC[v12]=             Revision control system plugin for Git (3.12)
9 HOMEPAGE=               https://github.com/msabramo/setuptools-git
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPIWHL/05/97/dd99fa9c0d9627a7b3c103a00f1566d8193aca8d473884ed258cca82b06f
14 DISTFILE[1]=            setuptools_git-1.2-py2.py3-none-any.whl:main
15 DF_INDEX=               1
16 SPKGS[v11]=             single
17 SPKGS[v12]=             single
18
19 OPTIONS_AVAILABLE=      PY311 PY312
20 OPTIONS_STANDARD=       none
21 VOPTS[v11]=             PY311=ON PY312=OFF
22 VOPTS[v12]=             PY311=OFF PY312=ON
23
24 DISTNAME=               setuptools_git-1.2.dist-info
25
26 GENERATED=              yes
27
28 [PY311].USES_ON=                        python:v11,wheel
29
30 [PY312].USES_ON=                        python:v12,wheel
31
32 [FILE:2895: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 Installation
53 ------------
54
55 With easy_install::
56
57   $> easy_install setuptools_git
58
59 Alternative manual installation::
60
61   $> tar -zxvf setuptools_git-X.Y.Z.tar.gz
62   $> cd setuptools_git-X.Y.Z
63   $> python setup.py install
64
65 Where X.Y.Z is a version number.
66
67 Usage
68 -----
69
70 To activate this plugin, you must first package your python module
71 with ``setup.py`` and use setuptools. The former is well documented in
72 the [distutils manual].
73
74 To use setuptools instead of distutils, just edit ``setup.py`` and
75 change:
76
77 .. code-block:: python
78
79   from distutils.core import setup
80
81 to:
82
83 .. code-block:: python
84
85   from setuptools import setup, find_packages
86
87 When Setuptools builds a source package, it always includes all files
88 tracked by your revision control system, if it knows how to learn what
89 those files are.
90
91 When Setuptools builds a binary package, you can ask it to include all
92 files tracked by your revision control system, by adding these argument
93 to your invocation of `setup()`:
94
95 .. code-block:: python
96
97   setup(...,
98         packages=find_packages(),
99         include_package_data=True,
100         ...)
101
102 which will detect that a directory is a package if it contains a
103 ``__init__.py`` file.  Alternatively, you can do without ``__init__.py``
104 files and tell Setuptools explicitly which packages to process:
105
106 .. code-block:: python
107
108   setup(...,
109         packages=["a_package", "another_one"],
110         include_package_data=True,
111         ...)
112
113 This plugin lets setuptools know what files are tracked by your git
114 revision control tool.  Setuptools ships with support for cvs and
115 subversion.  Other plugins like this one are available for bzr, darcs,
116 monotone, mercurial, and many others.
117
118 It might happen that you track files with your revision control system
119 that you don't want to include in your packages.  In that case, you
120 can prevent setuptools from packaging those files with a directive in
121 your ``MANIFEST.in``, for example::
122
123   exclude .gitignore
124   recursive-exclude images *.xcf *.blend
125
126 In this example, we prevent setuptools from packaging ``.gitignore and
127 the Gimp and Blender source files found under the images`` directory.
128
129 Files to exclude from the package can also be listed in the `setup()`
130 directive.  To do the same as the MANIFEST.in above, do:
131
132 .. code-block:: python
133
134
135 [FILE:118:distinfo]
136 e7764dccce7d97b4b5a330d7b966aac6f9ac026385743fd6cedad553f2494cfa        10965 setuptools_git-1.2-py2.py3-none-any.whl
137