Merge pull request #205 from graingert/move-bin-into-entry-points

Author: graingert

docs/source/NEWS.rst

@@ -5,6 +5,7 @@ Changelog
 -------------------
 
 - fix ``ModuleNotFoundError: No module named 'cStringIO'`` in ldaptor-ldap2pdns.
+- move scripts to console_scripts entry_points
 
 
 20.1.1 (2020-10-02)

ldaptor/_scripts/__init__.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import sys
 from ldaptor.protocols.ldap import ldapclient, ldapconnector, fetchschema
 from ldaptor import usage, config
@@ -59,7 +57,7 @@ class MyOptions(
     """LDAPtor command line schema fetching utility"""
 
 
-if __name__ == "__main__":
+def console_script():
     from twisted.python import log
 
     log.startLogging(sys.stderr, setStdout=0)
@@ -75,3 +73,7 @@ class MyOptions(
         baseDN=opts["base"], serviceLocationOverrides=opts["service-location"]
     )
     main(cfg)
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-fetchschema ldaptor/_scripts/fetchschema.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import sys
 from ldaptor.protocols.ldap.distinguishedname import DistinguishedName
 from twisted.internet.defer import DeferredList
@@ -54,9 +52,13 @@ def main(dns):
     sys.exit(exitStatus)
 
 
-if __name__ == "__main__":
+def console_script():
     if not sys.argv[1:]:
         print("%s: usage:" % sys.argv[0], file=sys.stderr)
         print("  %s DN.." % sys.argv[0], file=sys.stderr)
     else:
         main(sys.argv[1:])
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-find-server ldaptor/_scripts/find_server.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import sys
 from ldaptor.protocols.ldap import ldapclient, ldapsyntax, ldapconnector
 from ldaptor import usage, numberalloc, config
@@ -44,7 +42,7 @@ class MyOptions(
     """LDAPtor command line search utility"""
 
 
-if __name__ == "__main__":
+def console_script():
     from twisted.python import log
 
     log.startLogging(sys.stderr, setStdout=0)
@@ -60,3 +58,7 @@ class MyOptions(
         baseDN=opts["base"], serviceLocationOverrides=opts["service-location"]
     )
     main(cfg)
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-getfreenumber ldaptor/_scripts/getfreenumber.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # host fantasia {
 #  dhcp-client-identifier
 #  hardware ethernet 08:00:07:26:c0:a5;
@@ -14,7 +12,7 @@
 
 # shared-network "foo" {
 # }
-
+import sys
 from ldaptor.protocols.ldap import ldapclient, ldapconnector, ldapsyntax
 from ldaptor.protocols import pureber, pureldap
 from ldaptor import usage, ldapfilter, config
@@ -494,9 +492,7 @@ def parseArgs(self, filter=None):
         self.opts["filter"] = filter
 
 
-if __name__ == "__main__":
-    import sys
-
+def console_script():
     try:
         opts = MyOptions()
         opts.parseOptions()
@@ -512,3 +508,7 @@ def parseArgs(self, filter=None):
         opts["filter"],
         opts["dns-domain"],
     )
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-ldap2dhcpconf ldaptor/_scripts/ldap2dhcpconf.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 from ldaptor.protocols.ldap import ldapclient, ldapconnector, ldapsyntax
 from ldaptor.protocols import pureber, pureldap
 from ldaptor import usage, ldapfilter, config, dns
@@ -338,7 +336,7 @@ def parseArgs(self, domain, forward, filter=None):
         self.opts["filter"] = filter
 
 
-if __name__ == "__main__":
+def console_script():
     import sys
 
     try:
@@ -352,3 +350,7 @@ def parseArgs(self, domain, forward, filter=None):
         baseDN=opts["base"], serviceLocationOverrides=opts["service-location"]
     )
     main(cfg, opts["domain"], opts["forward"], opts["reverse"], opts["filter"])
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-ldap2dnszones ldaptor/_scripts/ldap2dnszones.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 from ldaptor.protocols.ldap import ldapclient, ldapconnector, ldapsyntax
 from ldaptor.protocols import pureber, pureldap
 from ldaptor import usage, ldapfilter, config, dns
@@ -229,7 +227,7 @@ def parseArgs(self, filter=None):
         self.opts["filter"] = filter
 
 
-if __name__ == "__main__":
+def console_script():
     try:
         opts = MyOptions()
         opts.parseOptions()
@@ -241,3 +239,7 @@ def parseArgs(self, filter=None):
         baseDN=opts["base"], serviceLocationOverrides=opts["service-location"]
     )
     main(cfg, opts["filter"])
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-ldap2maradns ldaptor/_scripts/ldap2maradns.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 import sys
 from ldaptor.protocols.ldap import ldapclient, ldapconnector, ldapsyntax
 from ldaptor.protocols import pureldap
@@ -85,7 +84,7 @@ def parseArgs(self, filter=None):
         self.opts["filter"] = filter
 
 
-if __name__ == "__main__":
+def console_script():
     try:
         opts = MyOptions()
         opts.parseOptions()
@@ -97,3 +96,7 @@ def parseArgs(self, filter=None):
         baseDN=opts["base"], serviceLocationOverrides=opts["service-location"]
     )
     main(cfg, opts["filter"])
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-ldap2passwd ldaptor/_scripts/ldap2passwd.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import sys
 from twisted.internet.defer import succeed, fail
 from twisted.internet import defer, reactor
@@ -286,7 +284,7 @@ class MyOptions(
     optParameters = (("dns-domain", None, "example.com", "DNS domain name"),)
 
 
-if __name__ == "__main__":
+def console_script():
     try:
         opts = MyOptions()
         opts.parseOptions()
@@ -301,3 +299,9 @@ class MyOptions(
     )
 
     main(cfg, opts["dns-domain"])
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-ldap2pdns ldaptor/_scripts/ldap2pdns.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import sys
 from ldaptor.protocols.ldap import ldif
 from ldaptor import usage, inmemory
@@ -51,7 +49,7 @@ def parseArgs(self, file1, file2):
         self.opts["file2"] = file2
 
 
-if __name__ == "__main__":
+def console_script():
     try:
         config = MyOptions()
         config.parseOptions()
@@ -60,3 +58,7 @@ def parseArgs(self, file1, file2):
         sys.exit(1)
 
     main(config.opts["file1"], config.opts["file2"], sys.stdout)
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-ldifdiff ldaptor/_scripts/ldifdiff.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import sys
 from ldaptor.protocols.ldap import ldif, ldifdelta
 from ldaptor import usage, inmemory
@@ -52,7 +50,7 @@ def parseArgs(self, data):
         self["data"] = data
 
 
-if __name__ == "__main__":
+def console_script():
     try:
         config = MyOptions()
         config.parseOptions()
@@ -62,3 +60,7 @@ def parseArgs(self, data):
 
     data = open(config["data"])
     main(data, sys.stdin, sys.stdout)
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-ldifpatch ldaptor/_scripts/ldifpatch.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import sys
 from ldaptor.protocols.ldap import ldapclient, ldapsyntax
 from ldaptor.protocols import pureldap
@@ -62,9 +60,13 @@ def main(servers):
     sys.exit(exitStatus)
 
 
-if __name__ == "__main__":
+def console_script():
     if not sys.argv[1:]:
         print("%s: usage:" % sys.argv[0], file=sys.stderr)
         print("  %s HOST.." % sys.argv[0], file=sys.stderr)
     else:
         main(sys.argv[1:])
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-namingcontexts ldaptor/_scripts/namingcontexts.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import sys, getpass
 from ldaptor.protocols.ldap import (
     ldapclient,
@@ -107,7 +105,7 @@ def parseArgs(self, *dnlist):
         self.opts["dnlist"] = dnlist
 
 
-if __name__ == "__main__":
+def console_script():
     import sys, os
     from twisted.python import log
 
@@ -141,3 +139,7 @@ def parseArgs(self, *dnlist):
     c.connect()
     reactor.run()
     sys.exit(exitStatus)
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-passwd ldaptor/_scripts/passwd.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import sys, os, getpass
 from ldaptor.protocols.ldap import (
     distinguishedname,
@@ -62,7 +60,7 @@ def parseArgs(self, fromDN, toDN):
         self.opts["to"] = toDN
 
 
-if __name__ == "__main__":
+def console_script():
     try:
         opts = MyOptions()
         opts.parseOptions()
@@ -85,3 +83,7 @@ def parseArgs(self, fromDN, toDN):
         f.close()
 
     main(cfg, opts["from"], opts["to"], opts["binddn"], bindPassword)
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-rename ldaptor/_scripts/rename.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import sys
 from ldaptor.protocols.ldap import ldapclient, ldapconnector, ldapsyntax
 from ldaptor import config, usage
@@ -52,7 +50,7 @@ def parseArgs(self, filter, *attributes):
         self.opts["attributes"] = attributes
 
 
-if __name__ == "__main__":
+def console_script():
     try:
         opts = MyOptions()
         opts.parseOptions()
@@ -64,3 +62,7 @@ def parseArgs(self, filter, *attributes):
         baseDN=opts["base"], serviceLocationOverrides=opts["service-location"]
     )
     main(cfg, opts["filter"], opts["attributes"])
+
+
+if __name__ == "__main__":
+    sys.exit(console_script())

bin/ldaptor-search ldaptor/_scripts/search.py

@@ -31,28 +31,8 @@ install_requires =
     pyparsing
     six >= 1.7
     zope.interface
-packages =
-    ldaptor
-    ldaptor.protocols
-    ldaptor.protocols.ldap
-    ldaptor.protocols.ldap.autofill
-    ldaptor.samba
-    ldaptor.test
+packages = find:
 scripts =
-    bin/ldaptor-ldap2dhcpconf
-    bin/ldaptor-ldap2maradns
-    bin/ldaptor-ldap2dnszones
-    bin/ldaptor-search
-    bin/ldaptor-namingcontexts
-    bin/ldaptor-passwd
-    bin/ldaptor-ldap2passwd
-    bin/ldaptor-getfreenumber
-    bin/ldaptor-ldap2pdns
-    bin/ldaptor-find-server
-    bin/ldaptor-rename
-    bin/ldaptor-fetchschema
-    bin/ldaptor-ldifdiff
-    bin/ldaptor-ldifpatch
 
 [options.extras_require]
 docs =
@@ -66,6 +46,24 @@ docs =
   sphinx~=3.2
   sphinx-rtd-theme~=0.5.0
 
+[options.entry_points]
+console_scripts =
+    ldaptor-ldap2dhcpconf = ldaptor._scripts.ldap2dhcpconf:console_script
+    ldaptor-ldap2maradns = ldaptor._scripts.ldap2maradns:console_script
+    ldaptor-ldap2dnszones = ldaptor._scripts.ldap2dnszones:console_script
+    ldaptor-search = ldaptor._scripts.search:console_script
+    ldaptor-namingcontexts = ldaptor._scripts.namingcontexts:console_script
+    ldaptor-passwd = ldaptor._scripts.passwd:console_script
+    ldaptor-ldap2passwd = ldaptor._scripts.ldap2passwd:console_script
+    ldaptor-getfreenumber = ldaptor._scripts.getfreenumber:console_script
+    ldaptor-ldap2pdns = ldaptor._scripts.ldap2pdns:console_script
+    ldaptor-find-server = ldaptor._scripts.find_server:console_script
+    ldaptor-rename = ldaptor._scripts.rename:console_script
+    ldaptor-fetchschema = ldaptor._scripts.fetchschema:console_script
+    ldaptor-ldifdiff = ldaptor._scripts.ldifdiff:console_script
+    ldaptor-ldifpatch = ldaptor._scripts.ldifpatch:console_script
+
+
 [bdist_wheel]
 universal = 1