first version of script to build a simple pacakage

Author: ChrisBarker-NOAA

Sources/code/make_my_package.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python
+
+"""
+A simple script that builds a as_simple_as_possible package
+to use for your own code.
+"""
+import sys, os
+
+USAGE = """
+python make_my_package.py your_package_name
+
+Running the script will create a minimal package
+you can use to manage your personal code
+"""
+
+setup_template = """#!/usr/bin/env python
+from setuptools import setup
+
+setup(name='{package_name}',
+      packages=['{package_name}'],
+      )
+
+"""
+
+test_code = '''#!/usr/bin/env python
+
+"""
+Just an example, but this could be a collection of utility functions, etc.
+
+Here would be documentation of what's in this file
+
+In this case, just one function to make sure it works.
+"""
+
+def test_fun():
+    print("yup -- this worked!!")
+
+'''
+
+if __name__ == "__main__":
+
+
+    try:
+        package_name = sys.argv[1]
+    except IndexError:
+        print("You need to provide a name for your package")
+        print(USAGE)
+        sys.exit(1)
+
+    this_dir = os.curdir
+    os.mkdir(package_name)
+    os.chdir(package_name)
+    with open("setup.py", 'w') as setupfile:
+        setupfile.write(setup_template.format(package_name=package_name))
+    os.mkdir(package_name)
+    os.chdir(package_name)
+    with open("__init__.py", 'w') as initfile:
+        initfile.write("#!/usr/bin/env python\n\n"
+                       "__version__ = '0.0.0'\n"
+                       )
+
+    with open("test_code.py", 'w') as initfile:
+        initfile.write(test_code)
+
+    os.chdir("../..")
+
+
+
+
+

Sources/source/where_to_put_your_code.rst

@@ -6,13 +6,17 @@ Where to put your custom code?
 
 A suggestion for how to manage your personal library of python functions you might use for scripting, data analysis, etc.
 
+
 TL; DR
 ======
 
 If you have a collection of your own code you want access to for various projects:
 
 Make a "package" out of it so you can manage it in one place, and use it in other places.
 
+You DO NOT NEED TO PUT IT ON PYPI !
+
+
 Introduction
 ------------
 
@@ -35,7 +39,7 @@ Step by step:
 
 1) Create a directory in your user (or home, or ... ) dir for your code. Let's call it "my_code".
 
-2) This is going to seem odd, but create another dir with the same name inside that -- this is where the actual code goes. (it's a convention to name the top dir the same thing as the "package" name, but it doesn't matter. But the inner name does -- that is the name of your package.
+2) This is going to seem odd, but create another dir with the same name inside that -- this is where the actual code goes. (it's a convention to name the top directory the same thing as the "package" name, but you don't have to follow that convention. But the inner name does -- that is the name of your package.
 
 3) In that dir, put in an empty, for now, file called ``__init__.py``.