git push origin master

Merge branch 'pip-compatible'

Author: ksindi

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Original work Copyright (c) Alex Gr�nholm
+Original work Copyright (c) Alex Gronholm
 Modified work Copyright (c) Kamil Sindi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

README.md

@@ -1,15 +1,30 @@
 flask-sqlacodegen
 =================
 
-Fork from <a href="https://pypi.python.org/pypi/sqlacodegen">sqlacodegen</a>. Based off of version 1.1.6.
+Fork of <a href="https://pypi.python.org/pypi/sqlacodegen">sqlacodegen</a> by Alex Gronholm. Based off of version 1.1.6.
 
 What's different:
-* Support for Flask-SQLAlchemy syntax using `--flask` option. All this means:
-  * SQLAlchemy class is instantiated (i.e. `db = SQLAlchemy()`).
-  * Flask-SQLAlchemy columns are used (e.g. `db.Integer`).
-  * Metadata is only implicit in tables
+* Use the command `flask-sqlacodgen` instead of `sqlacodegen`.
+* Support for Flask-SQLAlchemy syntax using `--flask` option:
+  - SQLAlchemy class is instantiated (i.e. `db = SQLAlchemy()`).
+  - Flask-SQLAlchemy columns are used (e.g. `db.Integer`).
+  - Metadata is only implicit in tables.
 * Defaults to generating backrefs in relationships. `--nobackref` still included as option in case backrefs are not wanted. 
-* Naming of backrefs is the class name is snake_case (as opposed to CamelCase) and is pluralized if it's Many-to-One or Many-to-Many using <a href="https://pypi.python.org/pypi/inflect">inflect</a>.
+* Naming of backrefs is class name in snake_case (as opposed to CamelCase) and is pluralized if it's Many-to-One or Many-to-Many using <a href="https://pypi.python.org/pypi/inflect">inflect</a>.
 * Generate explicit primary joins. I deal with pretty complicated tables that need explicit primary joins.
-* If column has a server_default set it to `FetchValue()` instead of trying to determine what that value is. Original code did not set the right server defaults in my set up.
-* `--ignorefk` ignores special name columns (e.g. id, inserted, updated) when generating association tables. Original code requires all columns to be foreign keys in order to generate association table. Example: `--ignorefk id,inserted,updated`.
+* If column has a server_default set it to `FetchValue()` instead of trying to determine what that value is. Original code did not set the right server defaults in my setup.
+* `--ignore-cols` ignores special columns when generating association tables. Original code requires all columns to be foreign keys in order to generate association table. Example: `--ignore-cols id,inserted,updated`.
+
+## Install
+
+With pip:
+```
+pip install flask-sqlacodegen
+```
+
+Without pip:
+```
+git clone https://github.com/ksindi/flask-sqlacodegen.git
+cd flask-sqlacodegen/
+python setup.py install
+```

README.rst

@@ -1,5 +1,4 @@
 import sys
-import os.path
 
 from setuptools import setup, find_packages
 from setuptools.command.test import test as TestCommand
@@ -23,17 +22,12 @@ def run_tests(self):
 if sys.version_info < (2, 7):
     extra_requirements = ('argparse',)
 
-here = os.path.dirname(__file__)
-readme_path = os.path.join(here, 'README.rst')
-readme = open(readme_path).read()
-
 setup(
-    name='sqlacodegen',
-    description='Automatic model code generator for SQLAlchemy',
-    long_description=readme,
+    name='flask-sqlacodegen',
+    description='Automatic model code generator for SQLAlchemy with Flask support',
+    long_description=open('README.md').read(),
     version=sqlacodegen.version,
     author='Kamil Sindi',
-    author_email='kysindi@gmail.com',
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
@@ -46,9 +40,11 @@ def run_tests(self):
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.2',
-        'Programming Language :: Python :: 3.3'
+        'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5'
     ],
-    keywords='sqlalchemy',
+    keywords=['sqlalchemy', 'flask-sqlacodegen', 'sqlacodegen'],
     license='MIT',
     packages=find_packages(exclude=['tests']),
     install_requires=(
@@ -60,7 +56,7 @@ def run_tests(self):
     zip_safe=False,
     entry_points={
         'console_scripts': [
-            'sqlacodegen=sqlacodegen.main:main'
+            'flask-sqlacodegen=sqlacodegen.main:main'
         ]
     }
 )

setup.py

@@ -527,7 +527,7 @@ class CodeGenerator(object):
 
     def __init__(self, metadata, noindexes=False, noconstraints=False,
                  nojoined=False, noinflect=False, nobackrefs=False,
-                 flask=False, fkcols=None):
+                 flask=False, ignore_cols=None):
         super(CodeGenerator, self).__init__()
 
         if noinflect:
@@ -537,7 +537,7 @@ def __init__(self, metadata, noindexes=False, noconstraints=False,
             inflect_engine = inflect.engine()
 
         # exclude these column names from consideration when generating association tables
-        _special_columns = fkcols or []
+        _ignore_columns = ignore_cols or []
 
         self.flask = flask
         if not self.flask:
@@ -551,7 +551,7 @@ def __init__(self, metadata, noindexes=False, noconstraints=False,
             # Link tables have exactly two foreign key constraints and all columns are involved in them
             # except for special columns like id, inserted, and updated
             fk_constraints = [constr for constr in table.constraints if isinstance(constr, ForeignKeyConstraint)]
-            if len(fk_constraints) == 2 and all(col.foreign_keys for col in table.columns if col.name not in _special_columns):
+            if len(fk_constraints) == 2 and all(col.foreign_keys for col in table.columns if col.name not in _ignore_columns):
                 association_tables.add(table.name)
                 tablename = sorted(fk_constraints, key=_get_constraint_sort_key)[0].elements[0].column.table.name
                 links[tablename].append(table)

sqlacodegen/codegen.py

@@ -36,9 +36,7 @@ def main():
     parser.add_argument('--outfile', help='file to write output to (default: stdout)')
     parser.add_argument('--nobackrefs', action='store_true', help="don't include backrefs")
     parser.add_argument('--flask', action='store_true', help="use Flask-SQLAlchemy columns")
-    parser.add_argument('--ignorefk', help="Don't check fk constraints on specified columns (comma-separated)")
-    # parser.add_argument('--outfile', type=argparse.FileType('w'), default=sys.stdout,
-    #                     help='file to write output to (default: stdout)')
+    parser.add_argument('--ignore-cols', help="Don't check foreign key constraints on specified columns (comma-separated)")
     args = parser.parse_args()
 
     if args.version:
@@ -53,10 +51,10 @@ def main():
     import_dialect_specificities(engine)
     metadata = MetaData(engine)
     tables = args.tables.split(',') if args.tables else None
-    fkcols = args.ignorefk.split(',') if args.ignorefk else None
+    ignore_cols = args.ignore_cols.split(',') if args.ignore_cols else None
     metadata.reflect(engine, args.schema, not args.noviews, tables)
     outfile = codecs.open(args.outfile, 'w', encoding='utf-8') if args.outfile else sys.stdout
     generator = CodeGenerator(metadata, args.noindexes, args.noconstraints,
                               args.nojoined, args.noinflect, args.nobackrefs,
-                              args.flask, fkcols)
+                              args.flask, ignore_cols)
     generator.render(outfile)