From d37aa4171740015b0e1f65b4678ccb02be9d8330 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Sun, 12 Mar 2017 20:53:46 +0300 Subject: [PATCH] Various minor updates in docs --- ChangeLog | 2 +- README.txt | 12 ++++++------ docs/conf.py | 3 ++- docs/index.rst | 16 +++++++++------- docs/mysql2sql.rst | 26 +++++++++++++------------- 5 files changed, 31 insertions(+), 28 deletions(-) diff --git a/ChangeLog b/ChangeLog index 9f735a7..29f6ac1 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,4 +1,4 @@ -Version 0.0.8 (2016-10-??) +Version 0.0.8 (2017-03-??) Extend tests, increase test coverage. diff --git a/README.txt b/README.txt index c419cf7..bbbb6bb 100644 --- a/README.txt +++ b/README.txt @@ -1,10 +1,10 @@ -Broytman SQL converter, Copyright (C) 2016 PhiloSoft Design -Author: Oleg Broytman -License: GPL +Broytman SQL converter, Copyright (C) 2016-2017 PhiloSoft Design. +Author: Oleg Broytman . +License: GPL. -This is sqlconvert, a library to perform SQL conversions. It uses -sqlparse to parse SQL and SQLObject to escape SQL strings and handle -connections. +sqlconvert is a library to perform SQL conversions. It uses sqlparse to +parse SQL and SQLObject to escape SQL strings and handle connections to DB +backends. The library is in the early stage of development and currently cannot do much. diff --git a/docs/conf.py b/docs/conf.py index 6b26626..ecbec32 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,6 +16,7 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # +from datetime import date # import os # import sys # sys.path.insert(0, os.path.abspath('.')) @@ -52,8 +53,8 @@ master_doc = 'index' # General information about the project. project = u'sqlconvert' -copyright = u'2016, Oleg Broytman' author = u'Oleg Broytman' +copyright = u'2016-%d, %s' % (date.today().year, author) # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/docs/index.rst b/docs/index.rst index d81db53..24c348b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,15 +6,17 @@ Welcome to sqlconvert's documentation! ===================================== -This is sqlconvert, a library to implement SQL converters. It uses `sqlparse +sqlconvert is a library to implement SQL converters. It uses `sqlparse `_ to parse SQL and `SQLObject -`_ to escape SQL strings and handle connections. +`_ to escape SQL strings and handle connections to +DB backends. -The library is in the early stage of development and currently cannot do much. +The library is in the early stage of development and currently cannot do +much. -The first goal is to implement `mysql2sql `_, a script intended -primarily to convert mysqldump (especially with extended INSERT syntax) to -standard SQL to load at least to PostgreSQL or SQLite. +The first goal is to implement `mysql2sql `_, a script +intended primarily to convert mysqldump (especially with extended INSERT +syntax) to standard SQL to load at least to PostgreSQL or SQLite. Contents: @@ -37,7 +39,7 @@ Credits Created by Oleg Broytman . -Copyright (C) 2016 PhiloSoft Design. +Copyright (C) 2016-2017 PhiloSoft Design. License diff --git a/docs/mysql2sql.rst b/docs/mysql2sql.rst index ec3062b..8e31058 100644 --- a/docs/mysql2sql.rst +++ b/docs/mysql2sql.rst @@ -2,13 +2,13 @@ mysql2sql ========= This is mysql2sql, a mysql to sql converter. It is primary intended to -convert mysqldump (especially with extended INSERT syntax) to standard -SQL to load at least to PostgreSQL or SQLite. +convert mysqldump (especially with extended INSERT syntax) to standard SQL +to load at least to PostgreSQL or SQLite. -The program is in the early stage of development and currently cannot do much. -It removes /\*! directives \*/, unquotes names quoted with backticks, quote -non-lowercase names with double quotes, unescapes strings and escapes them to a -different quoting style, and passes everything else unmodified. +The program is in the early stage of development and currently cannot do +much. It removes /\*! directives \*/, unquotes names quoted with backticks, +quote non-lowercase names with double quotes, unescapes strings and escapes +them to a different quoting style, and passes everything else unmodified. .. highlight:: none @@ -38,16 +38,16 @@ Options:: infile Input file, stdin if absent or '-' -o, --outfile outfile Output file, stdout if absent or '-' -Options `-m/-p/-s` change quoting style. `-m` sets MySQL quoting style; it's -added to use the program in the following scenario: convert MySQL dumps with -extended INSERTs to SQL with plain INSERTS suitable to be fed back to MySQL. -`-p` sets PostgreSQL quoting style; it's like MySQL with additional `E''-style -quoting +Options `-m/-p/-s` change quoting style. `-m` sets MySQL quoting style; +it's added to use the program in the following scenario: convert MySQL +dumps with extended INSERTs to SQL with plain INSERTS suitable to be fed +back to MySQL. `-p` sets PostgreSQL quoting style; it's like MySQL with +additional `E''-style quoting `_. `-s` sets generic SQL/SQLite quoting style; this is the default. -If stderr is connected to the console the program displays a text mode progress -bar. Option `-P/--no-pbar` inhibits it. +If stderr is connected to the console the program displays a text mode +progress bar. Option `-P/--no-pbar` inhibits it. Option `-o` is useful when infile is absent (input is redirected), for example:: -- 2.39.2