Skip to content

Commit 5af1a48

Browse files
committed
Update README.md
1 parent dd2ace8 commit 5af1a48

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
1-
flask-sqlacodegen
2-
=================
1+
# flask-sqlacodegen
32

43
GitHub page: [flask-sqlacodegen](https://github.com/ksindi/flask-sqlacodegen)
54

65
Fork of [sqlacodegen](https://pypi.python.org/pypi/sqlacodegen) by Alex Gronholm. Based off of version 1.1.6.
76

87
What's different:
98

10-
* Support for Flask-SQLAlchemy syntax using `--flask` option:
9+
* Support for Flask-SQLAlchemy syntax using `--flask` option.
1110
* Defaults to generating backrefs in relationships. `--nobackref` still included as option in case backrefs are not wanted.
12-
* 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>.
13-
* Generate explicit primary joins. I deal with pretty complicated tables that need explicit primary joins.
11+
* 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 [inflect](https://pypi.python.org/pypi/inflect).
12+
* Primary joins are explicit.
1413
* 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.
1514
* `--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`.
16-
* Use the command `flask-sqlacodgen` instead of `sqlacodegen`.
15+
* Uses the command `flask-sqlacodgen` instead of `sqlacodegen`.
1716

1817
## Install
1918

README.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,21 @@ Alex Gronholm. Based off of version 1.1.6.
99

1010
What's different:
1111

12-
- Support for Flask-SQLAlchemy syntax using ``--flask`` option:
12+
- Support for Flask-SQLAlchemy syntax using ``--flask`` option.
1313
- Defaults to generating backrefs in relationships. ``--nobackref``
1414
still included as option in case backrefs are not wanted.
1515
- Naming of backrefs is class name in snake\_case (as opposed to
1616
CamelCase) and is pluralized if it's Many-to-One or Many-to-Many
17-
using inflect.
18-
- Generate explicit primary joins. I deal with pretty complicated
19-
tables that need explicit primary joins.
17+
using `inflect <https://pypi.python.org/pypi/inflect>`__.
18+
- Primary joins are explicit.
2019
- If column has a server\_default set it to ``FetchValue()`` instead of
2120
trying to determine what that value is. Original code did not set the
2221
right server defaults in my setup.
2322
- ``--ignore-cols`` ignores special columns when generating association
2423
tables. Original code requires all columns to be foreign keys in
2524
order to generate association table. Example:
2625
``--ignore-cols id,inserted,updated``.
27-
- Use the command ``flask-sqlacodgen`` instead of ``sqlacodegen``.
26+
- Uses the command ``flask-sqlacodgen`` instead of ``sqlacodegen``.
2827

2928
Install
3029
-------

0 commit comments

Comments
 (0)