/usr/lib/python3/dist-packages/stdeb-0.8.2.egg-info is in python3-stdeb 0.8.2-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 | Metadata-Version: 1.1
Name: stdeb
Version: 0.8.2
Summary: Python to Debian source package conversion utility
Home-page: http://github.com/astraw/stdeb
Author: Andrew Straw
Author-email: strawman@astraw.com
License: MIT
Description: .. image:: https://travis-ci.org/astraw/stdeb.png?branch=master
:target: https://travis-ci.org/astraw/stdeb
stdeb - Python to Debian source package conversion utility
==========================================================
`stdeb <http://github.com/astraw/stdeb>`_ produces Debian source
packages from Python packages via a new distutils command,
``sdist_dsc``. Automatic defaults are provided for the Debian package,
but many aspects of the resulting package can be customized (see the
customizing section, below). An additional command, ``bdist_deb``,
creates a Debian binary package, a .deb file. The ``install_deb``
command installs this .deb file. The ``debianize`` command builds a
``debian/`` directory directly alongside your setup.py.
Several convenience utilities are also provided:
* ``pypi-download`` will query the `Python Package Index (PyPI)
<http://pypi.python.org/>`_ for a package and download it.
* ``pypi-install`` will query the `Python Package Index (PyPI)
<http://pypi.python.org/>`_ for a package, download it, create a
.deb from it, and then install the .deb.
* ``py2dsc`` will convert a distutils-built source tarball into a
Debian source package.
* ``py2dsc-deb`` will convert a distutils-built source tarball into a
Debian source package and then use the Debian machinery to build a
.deb file from this.
.. contents::
Python 3 support
----------------
As explained in more detail below, the heart of stdeb is the sdist_dsc
distutils command. This command runs once to generate a Debian source
package. This Debian source package can specify building packages for
Python 2, Python 3, or both. Furthermore, this generation can be done
with the Python 2 or Python 3 interpreter. By default, only packages
are built for the version of Python being used. To override this, use
``--with-python2=True`` or ``--with-python3=True`` as an argument to
the sdist_dsc distutils command (or use both to be sure). For example,
to build only a Python 3 package using the Python 3 interpreter::
python3 setup.py --command-packages=stdeb.command bdist_deb
To build both Python 2 and Python 3 packages using the Python 3
interpreter (and only the Python3 package installs scripts)::
python3 setup.py --command-packages=stdeb.command sdist_dsc --with-python2=True --with-python3=True --no-python2-scripts=True bdist_deb
News
----
master branch
`````````````
This branch is recommended for all users. It is currently tested on
Ubuntu 12.04.
* 2014-8-14: **Version 0.8.2**. See the `download page
<https://pypi.python.org/pypi/stdeb/0.8.2>`__. This is a bugfix
release fixing a serious issue that would cause a Python 2 package
to be built if only a Python 3 package was requested in some
circumstances.
* 2014-8-10: **Version 0.8.1**. See the `download page
<https://pypi.python.org/pypi/stdeb/0.8.1>`__. Due
to bugs in 0.8.0, this release is the first announced from the 0.8
series. Highlights since 0.7.1:
- Full support for Python 3. This includes being run from Python 3
and generating packages for Python 3. The default is to build
Python 3 packages when run with Python 3 and to build Python 2
packages when run from Python 2. Command line options can be used
to build packages for the other Python interpreter, too.
- Build .changes file for source package. While this still must be
signed for upload to a PPA, for example, it should still be
useful in some cases.
- Switch to Debian source format 3.0 (quilt). Practically speaking,
the .diff.gz file that used to come with a source package is now
replaced by a .debian.tar.gz file.
- Verify SSL certificates when talking to PyPI using
Requests. (Verification requires Requests >= 0.8.8.)
- Many bugfixes.
* 2014-05-05: **Version 0.7.1**. See the `download page
<https://pypi.python.org/pypi/stdeb/0.7.1>`__. Highlights for this
release (you may also wish to consult the full `changelog
<http://github.com/astraw/stdeb/blob/release-0.7.1/CHANGELOG.txt>`__). Due
to bugs in 0.7.0, this release is the first announced from the 0.7
series. Highlights since 0.6.0:
- New commands: pypi-download and pypi-install to directly download
and install packages from PyPI, respectively. py2dsc-deb directly
creates a .deb file from a source tarball.
- New distutils command: install_deb lets you directly install a
python package as a standard system package.
- Many bugfixes, including the new URL for PyPI.
- Automated runs of test suite, thanks to Travis CI
- Thanks to many, especially Piotr Ożarowski for help with stdeb.
* 2010-06-18: **Version 0.6.0**. See the `download page
<http://pypi.python.org/pypi/stdeb/0.6.0>`__. Highlights for this
release (you may also wish to consult the full `changelog
<http://github.com/astraw/stdeb/blob/release-0.6.0/CHANGELOG.txt>`__):
- A new ``debianize`` command to build a ``debian/`` directory
alongside your setup.py file.
- Bugfixes.
* 2010-01-09: **Version 0.5.1**. Bugfix release. See the `download
page <http://pypi.python.org/pypi/stdeb/0.5.1>`__, the `changelog
<http://github.com/astraw/stdeb/blob/release-0.5.1/CHANGELOG.txt>`__
and `release notes
<http://github.com/astraw/stdeb/blob/release-0.5.1/RELEASE_NOTES.txt>`__.
* 2009-12-30: **Version 0.5.0**. See the `download page
<http://pypi.python.org/pypi/stdeb/0.5.0>`__. Highlights for this
release (you may also wish to consult the full `changelog
<http://github.com/astraw/stdeb/blob/release-0.5.0/CHANGELOG.txt>`__):
- A new ``pypi-install`` script will automatically download, make a
.deb, and install packages from the `Python Package Index (PyPI)`_.
- Removal of the setuptools dependency.
- New option (`--guess-conflicts-provides-replaces`) to query
original Debian packages for Conflicts/Provides/Replaces
information.
- As a result of these changes and to fix a couple bugs/warts, some
minor backwards incompatible changes and deprecations were
made. Please check the `release notes
<http://github.com/astraw/stdeb/blob/release-0.5.0/RELEASE_NOTES.txt>`__.
* 2009-12-28: Version 0.4.3 Released. See the `download page`__. See the
`changelog`__ and `release notes`__.
* 2009-11-02: Version 0.4.2 Released. See the `download page`__. See the
`changelog`__ and `release notes`__.
* 2009-10-04: Version 0.4.1 Released. See the `download page`__. See the
`changelog`__ and `release notes`__.
* 2009-09-27: Version 0.4 Released. See the `download page`__. This
version switches to debhelper 7. See the `Changelog for 0.4`__.
__ http://pypi.python.org/pypi/stdeb/0.4.3
__ http://github.com/astraw/stdeb/blob/release-0.4.3/CHANGELOG.txt
__ http://github.com/astraw/stdeb/blob/release-0.4.3/RELEASE_NOTES.txt
__ http://pypi.python.org/pypi/stdeb/0.4.2
__ http://github.com/astraw/stdeb/blob/release-0.4.2/CHANGELOG.txt
__ http://github.com/astraw/stdeb/blob/release-0.4.2/RELEASE_NOTES.txt
__ http://pypi.python.org/pypi/stdeb/0.4.1
__ http://github.com/astraw/stdeb/blob/release-0.4.1/CHANGELOG.txt
__ http://github.com/astraw/stdeb/blob/release-0.4.1/RELEASE_NOTES.txt
__ http://pypi.python.org/pypi/stdeb/0.4
__ http://github.com/astraw/stdeb/blob/release-0.4/CHANGELOG.txt
old-stable branch (0.3 and earlier)
```````````````````````````````````
This branch is recommended if you are operating on older Debian/Ubuntu
distributions. It is compatible with Ubuntu Hardy.
* 2009-10-04: Version 0.3.2 Released. See the `download page`__. See the `Changelog for 0.3.2`__
* 2009-09-27: Version 0.3.1 Released. See the `download page`__. See the `Changelog for 0.3.1`__
* 2009-03-21: Version 0.3 Released. See the `download page`__. See the `Changelog for 0.3`__
* 2009-02-17: Version 0.2.3 Released. See the `download page`__. See the `Changelog for 0.2.3`__
* 2009-01-29: Version 0.2.2 Released. See the `download page`__. See the `Changelog for 0.2.2`__
* 2008-04-26: Version 0.2.1 Released. See the `download page`__. See the `Changelog for 0.2.1`__
* 2008-04-26: Version 0.2 Released. See the `download page`__. See the `Changelog for 0.2`__
* 2007-04-02: Version 0.2.a1 Released. See the `old download page`_.
* 2006-06-19: Version 0.1 Released. See the `old download page`_.
__ http://pypi.python.org/pypi/stdeb/0.3.2
__ http://github.com/astraw/stdeb/blob/release-0.3.2/CHANGELOG.txt
__ http://pypi.python.org/pypi/stdeb/0.3.1
__ http://github.com/astraw/stdeb/blob/release-0.3.1/CHANGELOG.txt
__ http://pypi.python.org/pypi/stdeb/0.3
__ http://github.com/astraw/stdeb/blob/release-0.3/CHANGELOG.txt
__ http://pypi.python.org/pypi/stdeb/0.2.3
__ http://github.com/astraw/stdeb/blob/release-0.2.3/CHANGELOG.txt
__ http://pypi.python.org/pypi/stdeb/0.2.2
__ http://github.com/astraw/stdeb/blob/release-0.2.2/CHANGELOG.txt
__ http://pypi.python.org/pypi/stdeb/0.2.1
__ http://github.com/astraw/stdeb/blob/release-0.2.1/CHANGELOG.txt
__ http://pypi.python.org/pypi/stdeb/0.2
__ http://github.com/astraw/stdeb/blob/release-0.2/CHANGELOG.txt
The commands
------------
pypi-download, command-line command
```````````````````````````````````
``pypi-download`` takes a package name, queries PyPI for it and downloads
it::
pypi-download [options] mypackage
pypi-install, command-line command
``````````````````````````````````
``pypi-install`` takes a package name, queries PyPI for it, downloads
it, builds a Debian source package and then .deb from it, and this
installs it::
pypi-install [options] mypackage
py2dsc, command-line command
````````````````````````````
``py2dsc`` takes a .tar.gz source package and build a Debian source
package from it::
py2dsc [options] mypackage-0.1.tar.gz # uses pre-built Python source package
py2dsc-deb, command-line command
````````````````````````````````
``py2dsc-deb`` takes a .tar.gz source package and build a Debian source
package and then a .deb file from it::
py2dsc-deb [options] mypackage-0.1.tar.gz # uses pre-built Python source package
sdist_dsc, distutils command
````````````````````````````
All methods eventually result in a call to the ``sdist_dsc`` distutils
command. You may prefer to do so directly::
python setup.py --command-packages=stdeb.command sdist_dsc
A Debian source package is produced from unmodified
Python packages. The following files are produced in a newly created
subdirectory ``deb_dist``:
* ``packagename_versionname.orig.tar.gz``
* ``packagename_versionname-debianversion.dsc``
* ``packagename_versionname-debianversion.diff.gz``
These can then be compiled into binary packages using the standard
Debian machinery (e.g. dpkg-buildpackage).
bdist_deb, distutils command
````````````````````````````
A ``bdist_deb`` distutils command is installed. This calls the
sdist_dsc command and then runs dpkg-buildpackage on the result::
python setup.py --command-packages=stdeb.command bdist_deb
install_deb, distutils command
``````````````````````````````
The ``install_deb`` distutils command calls the bdist_deb command and
then installs the result. You need to run this with superuser privilege::
sudo python setup.py --command-packages=stdeb.command install_deb
debianize, distutils command
````````````````````````````
The ``debianize`` distutils command builds the same ``debian/``
directory as used in the previous command, but the output is placed
directly in the project's root folder (alongside setup.py). This is
useful for customizing the Debian package directly (rather than using
the various stdeb options to tune the generated package).
::
python setup.py --command-packages=stdeb.command debianize
A note about telling distutils to use the stdeb distutils commands
``````````````````````````````````````````````````````````````````
Distutils command packages can also be specified in distutils
configuration files (rather than using the ``--command-packages``
command line argument to ``setup.py``), as specified in the `distutils
documentation
<https://docs.python.org/2/distutils/extending.html>`_. Specifically,
you could include this in your ``~/.pydistutils.cfg`` file::
[global]
command-packages: stdeb.command
Examples
--------
These all assume you have stdeb installed in your system Python
path. stdeb also works from a non-system Python path (e.g. a
`virtualenv <http://pypi.python.org/pypi/virtualenv>`_).
Quickstart 1: Install something from PyPI now, I don't care about anything else
```````````````````````````````````````````````````````````````````````````````
Do this from the command line::
pypi-install mypackage
**Warning: Despite doing its best, there is absolutely no way stdeb
can guarantee all the Debian package dependencies will be properly
fulfilled without manual intervention. Using pypi-install bypasses
your ability to customize stdeb's behavior. Read the rest of this
document to understand how to make better packages.**
Quickstart 2: Just tell me the fastest way to make a .deb
`````````````````````````````````````````````````````````
(First, install stdeb as you normally install Python packages.)
Do this from the directory with your `setup.py` file::
python setup.py --command-packages=stdeb.command bdist_deb
This will make a Debian source package (.dsc, .orig.tar.gz and
.diff.gz files) and then compile it to a Debian binary package (.deb)
for your current system. The result will be in ``deb_dist``.
**Warning: installing the .deb file on other versions of Ubuntu or
Debian than the one on which it was compiled will result in undefined
behavior. If you have extension modules, they will probably
break. Even in the absence of extension modules, bad stuff will likely
happen.**
For this reason, it is much better to build the Debian source package
and then compile that (e.g. using `Ubuntu's PPA`__) for each target
version of Debian or Ubuntu.
__ https://help.launchpad.net/Packaging/PPA
Quickstart 3: I read the warning, so show me how to make a source package, then compile it
``````````````````````````````````````````````````````````````````````````````````````````
This generates a source package::
wget http://pypi.python.org/packages/source/R/Reindent/Reindent-0.1.0.tar.gz
py2dsc Reindent-0.1.0.tar.gz
This turns it into a .deb using the standard Debian tools. (Do *this*
on the same source package for each target distribution)::
cd deb_dist/reindent-0.1.0/
dpkg-buildpackage -rfakeroot -uc -us
This installs it::
cd ..
sudo dpkg -i python-reindent_0.1.0-1_all.deb
Quickstart 4: Install from a Python package direct to a debian system package
`````````````````````````````````````````````````````````````````````````````
(First, install stdeb as you normally install Python packages.)
Do this from the directory with your `setup.py` file::
python setup.py --command-packages=stdeb.command install_deb
This will make a Debian source package (.dsc, .orig.tar.gz and
.diff.gz files), compile it to a Debian binary package (.deb) for your
current system and then install it using ``dpkg``.
Another example, with more explanation
``````````````````````````````````````
This example is more useful if you don't have a Python source package
(.tar.gz file generated by ``python setup.py sdist``). For the sake of
illustration, we do download such a tarball, but immediately unpack it
(alternatively, use a version control system to grab the unpacked
source of a package)::
wget http://pypi.python.org/packages/source/R/Reindent/Reindent-0.1.0.tar.gz
tar xzf Reindent-0.1.0.tar.gz
cd Reindent-0.1.0
The following will generate a directory ``deb_dist`` containing the
files ``reindent_0.1.0-1.dsc``, ``reindent_0.1.0.orig.tar.gz`` and
``reindent_0.1.0-1.diff.gz``, which, together, are a debian source
package::
python setup.py --command-packages=stdeb.command sdist_dsc
The source generated in the above way is also extracted (using
``dpkg-source -x``) and placed in the ``deb_dist`` subdirectory. To
continue the example above::
cd deb_dist/reindent-0.1.0
dpkg-buildpackage -rfakeroot -uc -us
Finally, the generated package can be installed::
cd ..
sudo dpkg -i python-reindent_0.1.0-1_all.deb
For yet another example of use, with still more explanation, see
`allmydata-tahoe ticket 251`_.
.. _allmydata-tahoe ticket 251: http://allmydata.org/trac/tahoe/ticket/251
Download
--------
Files are available at the `download page`_ (for ancient releases, see
the `old download page`_).
.. _download page: https://pypi.python.org/pypi/stdeb
.. _old download page: http://stdeb.python-hosting.com/wiki/Download
The git repository is available at
http://github.com/astraw/stdeb
Install (or, using stdeb to create an stdeb installer)
------------------------------------------------------
For a bit of fun, here's how to install stdeb using stdeb. Note that
stdeb is also in Debian and Ubuntu, so this recipe is only necessary
to install a more recent stdeb.
::
STDEB_VERSION="0.7.1"
# Download stdeb
wget http://pypi.python.org/packages/source/s/stdeb/stdeb-$STDEB_VERSION.tar.gz
# Extract it
tar xzf stdeb-$STDEB_VERSION.tar.gz
# Enter extracted source package
cd stdeb-$STDEB_VERSION
# Build .deb (making use of stdeb package directory in sys.path).
python setup.py --command-packages=stdeb.command bdist_deb
# Install it
sudo dpkg -i deb_dist/python-stdeb_$STDEB_VERSION-1_all.deb
Background
----------
For the average Python package, its source distribution
(python_package.tar.gz created with ``python setup.py sdist``)
contains nearly everything necessary to make a Debian source
package. This near-equivalence encouraged me to write this distutils
extension, which executes the setup.py file to extract relevant
information. `setuptools
<http://peak.telecommunity.com/DevCenter/setuptools>`_ may optionally
be used.
I wrote this initially to Debianize several Python packages of my own,
but I have the feeling it could be generally useful. It appears
similar, at least in theory, to easydeb_, `Logilab's Devtools`_,
bdist_dpkg_, bdist_deb_, pkgme_ and `dh-virtualenv
<https://github.com/spotify/dh-virtualenv>`__.
.. _easydeb: http://easy-deb.sourceforge.net/
.. _Logilab's DevTools: http://www.logilab.org/projects/devtools
.. _bdist_dpkg: http://svn.python.org/view/sandbox/trunk/Lib/bdist_dpkg.py
.. _bdist_deb: http://bugs.python.org/issue1054967
.. _pkgme: https://launchpad.net/pkgme
Features
--------
* Create a package for all Python versions supported by
python-support. (Limiting this range is possible with the
``XS-Python-Version:`` config option.)
* Automatic conversion of Python package names into valid Debian
package names.
* Attempt to automatically convert version numbers such that ordering
is maintained. See also the config option
``Forced-Upstream-Version``.
* Fine grained control of version numbers. (``Debian-Version``,
``Forced-Upstream-Version``, ``Upstream-Version-Prefix``,
``Upstream-Version-Suffix`` config options.)
* Install .desktop files. (``MIME-Desktop-Files`` config option.)
* Install .mime and .sharedmimeinfo files. (``MIME-File`` and
``Shared-MIME-File`` config options.)
* Install copyright files. (``Copyright-File`` config option.)
* Apply patches to upstream sources. (``Stdeb-Patch-File`` config
option.)
* Pass environment variables to setup.py script. (``Setup-Env-Vars``
config option.)
Customizing the produced Debian source package (config options)
---------------------------------------------------------------
stdeb will attempt to provide reasonable defaults, but these are only
guesses.
There are two ways to customize the Debian source package produced by
stdeb. First, you may provide options to the distutils
commands. Second, you may provide an ``stdeb.cfg`` file.
stdeb distutils command options
```````````````````````````````
The sdist_dsc command takes command-line options to the distutils
command. For example::
python setup.py --command-packages=stdeb.command sdist_dsc --debian-version 0MyName1
This creates a Debian package with the Debian version set to
"0MyName1".
These options can also be set via distutils configuration
files. (These are the ``setup.cfg`` file alongside ``setup.py`` and
the ~/.pydistutils.cfg file.) In that case, put the arguments in the
``[sdist_dsc]`` section. For example, a project's ``~/.setup.cfg``
file might have this::
[sdist_dsc]
debian-version: 0MyName1
To pass these commands to sdist_dsc when calling bdist_deb, do this::
python setup.py sdist_dsc --debian-version 0MyName1 bdist_deb
====================================== =========================================
Command line option Effect
====================================== =========================================
--with-python2 build Python 2 package (default=True)
--with-python3 build Python 3 package (default=False)
--no-python2-scripts disable installation of Python 2 scripts (default=False)
--no-python3-scripts disable installation of Python 3 scripts (default=False)
--dist-dir (-d) directory to put final built
distributions in (default='deb_dist')
--patch-already-applied (-a) patch was already applied (used when
py2dsc calls sdist_dsc)
--default-distribution deprecated (see --suite)
--suite (-z) distribution name to use if not
specified in .cfg (default='unstable')
--default-maintainer deprecated (see --maintainer)
--maintainer (-m) maintainer name and email to use if not
specified in .cfg (default from
setup.py)
--extra-cfg-file (-x) additional .cfg file (in addition to
stdeb.cfg if present)
--patch-file (-p) patch file applied before setup.py
called (incompatible with file
specified in .cfg)
--patch-level (-l) patch file applied before setup.py
called (incompatible with file
specified in .cfg)
--patch-posix (-q) apply the patch with --posix mode
--remove-expanded-source-dir (-r) remove the expanded source directory
--ignore-install-requires (-i) ignore the requirements from
requires.txt in the egg-info directory
--no-backwards-compatibility This option has no effect, is here for
backwards compatibility, and may be
removed someday.
--guess-conflicts-provides-replaces If True, attempt to guess
Conflicts/Provides/Replaces in
debian/control based on apt-cache
output. (Default=False).
--use-premade-distfile (-P) use .zip or .tar.gz file already made
by sdist command
--source debian/control Source: (Default:
<source-debianized-setup-name>)
--package debian/control Package: (Default:
python-<debianized-setup-name>)
--suite suite (e.g. stable, lucid) in changelog
(Default: unstable)
--maintainer debian/control Maintainer: (Default:
<setup-maintainer-or-author>)
--debian-version debian version (Default: 1)
--section debian/control Section: (Default:
python)
--epoch version epoch
--forced-upstream-version forced upstream version
--upstream-version-prefix upstream version prefix
--upstream-version-suffix upstream version suffix
--uploaders uploaders
--copyright-file copyright file
--build-depends debian/control Build-Depends:
--build-conflicts debian/control Build-Conflicts:
--stdeb-patch-file file containing patches for stdeb to
apply
--stdeb-patch-level patch level provided to patch command
--depends debian/control Depends:
--suggests debian/control Suggests:
--recommends debian/control Recommends:
--xs-python-version debian/control XS-Python-Version:
--dpkg-shlibdeps-params parameters passed to dpkg-shlibdeps
--conflicts debian/control Conflicts:
--provides debian/control Provides:
--replaces debian/control Replaces:
--mime-desktop-files MIME desktop files
--mime-file MIME file
--shared-mime-file shared MIME file
--setup-env-vars environment variables passed to
setup.py
--udev-rules file with rules to install to udev
====================================== =========================================
You may also pass any arguments described below for the stdeb.cfg file
via distutils options. Passing the arguments this way (either on the
command line, or in the ``[sdist_dsc]`` section of a distutils .cfg
file) will take precedence. The option name should be given in lower
case.
stdeb.cfg configuration file
````````````````````````````
You may write config files of the format understood by `ConfigParser
<http://docs.python.org/lib/module-ConfigParser.html>`_. When building
each package, stdeb looks for the existance of a ``stdeb.cfg`` in the
directory with ``setup.py``. You may specify an additional config file
with the command-line option --extra-cfg-file. The section should
should either be [DEFAULT] or [package_name], which package_name is
specified as the name argument to the setup() command. An example
stdeb.cfg file is::
[DEFAULT]
Depends: python-numpy
XS-Python-Version: >= 2.6
All available options:
====================================== =========================================
Config file option Effect
====================================== =========================================
Source debian/control Source: (Default:
<source-debianized-setup-name>)
Package debian/control Package: (Default:
python-<debianized-setup-name>)
Suite suite (e.g. stable, lucid) in changelog
(Default: unstable)
Maintainer debian/control Maintainer: (Default:
<setup-maintainer-or-author>)
Debian-Version debian version (Default: 1)
Section debian/control Section: (Default:
python)
Epoch version epoch
Forced-Upstream-Version forced upstream version
Upstream-Version-Prefix upstream version prefix
Upstream-Version-Suffix upstream version suffix
Uploaders uploaders
Copyright-File copyright file
Build-Depends debian/control Build-Depends:
Build-Conflicts debian/control Build-Conflicts:
Stdeb-Patch-File file containing patches for stdeb to
apply
Stdeb-Patch-Level patch level provided to patch command
Depends debian/control Depends:
Suggests debian/control Suggests:
Recommends debian/control Recommends:
XS-Python-Version debian/control XS-Python-Version:
Dpkg-Shlibdeps-Params parameters passed to dpkg-shlibdeps
Conflicts debian/control Conflicts:
Provides debian/control Provides:
Replaces debian/control Replaces:
MIME-Desktop-Files MIME desktop files
MIME-File MIME file
Shared-MIME-File shared MIME file
Setup-Env-Vars environment variables passed to
setup.py
Udev-Rules file with rules to install to udev
====================================== =========================================
The option names in stdeb.cfg files are not case sensitive.
Prerequisites
-------------
* Python 2.5 or higher
* Standard Debian utilities such as ``date``, ``dpkg-source`` and
Debhelper 7 (use stdeb 0.3.x if you need to support older
distributions without dh7)
* If your setup.py uses the setuptools features ``setup_requires`` or
``install_requires``, you must run ``apt-file update`` prior to
running any stdeb command.
TODO
----
* Make output meet `Debian Python Policy`_ specifications or the `new
python policy`_. This will include several things, among which are:
- the ability to make custom changelogs
- the ability to include project-supplied documentation as a -doc package
- include license information in debian/copyright
- the ability to include project-supplied examples, tests, and data
as a separate package
- much more not listed
* Create (better) documentation
* Log output using standard distutils mechanisms
* Refactor the source code to have a simpler, more sane design
.. _debian python policy: http://www.debian.org/doc/packaging-manuals/python-policy/
.. _new python policy: http://wiki.debian.org/DebianPython/NewPolicy
Call for volunteers
-------------------
I don't have a lot of time for this. This project stands a very real
chance of being only a shadow of its potential self unless people step
up and contribute. There are numerous ways in which people could
help. In particular, I'd be interested in finding a co-maintainer or
maintainer if the project generates any interest. Secondarily, I would
appreciate advice from Debian developers or Ubuntu MOTUs about the
arcane details of Python packaging.
Mailing list
------------
Please address all questions to the distutils-SIG_
.. _distutils-SIG: http://mail.python.org/mailman/listinfo/distutils-sig
License
-------
MIT-style license. Copyright (c) 2006-2014 stdeb authors.
See the LICENSE.txt file provided with the source distribution for
full details.
Authors
-------
* Andrew Straw <strawman@astraw.com>
* Pedro Algarvio, aka, s0undt3ch <ufs@ufsoft.org>
* Gerry Reno (initial bdist_deb implementation)
Additional Credits
------------------
* Zooko O'Whielacronx for the autofind-depends patch.
* Brett (last name unknown) for the --ignore-install-requires patch.
* Ximin Luo for a bug fix.
* Alexander D. Sedov for bug fixes and suggestions.
* Michele Mattioni for bug fix.
* Alexander V. Nikolaev for the debhelper buildsystem specification.
* Roland Sommer for the description field bugfix.
* Barry Warsaw for suggesting the debianize command.
* Asheesh Laroia for updating the PyPI URL.
* Piotr Ożarowski for implementing dh_python2 support.
* GitHub_ for hosting services.
* WebFaction_ (aka `python-hosting`_) for previous hosting services.
* TravisCI_ for continuous integration
.. _GitHub: http://github.com/
.. _WebFaction: http://webfaction.com/
.. _python-hosting: http://python-hosting.com/
.. _TravisCI: http://travis-ci.org/
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
|