search

seanharr11 / etlalchemy

Extract, Transform, Load: Any SQL Database in 4 lines of Code.
MIT License
556 stars 83 forks source link

Readme cleanup suggestions #43

Closed tpow closed 5 years ago

tpow commented 5 years ago

The readme file is very helpful as is, but I think it could be cleaned up and simplified.

In the Basic Usage section, it would be easier to understand and more consistent with the other examples if mssql_db_source was renamed to simply source. Similarly, mysql_db_target should be renamed to target. This teaches users that the main difference is due to the connection string.

In all the rest of the examples, I'd remove the keyword arg style conn_string= and just reference it positionally like in the Basic Usage section. This would be more typical python usage and is shorter.

In the "Provide a list of tables to include/exclude in migration" example, I would switch it to match the order of the description. In other words, make it have included_tables as the first section and show the excluded_tables example second. I'm guessing many people testing start with including one or a few tables so this may be more helpful.

In the Installation section, it may be helpful to note that the appropriate DBAPI module to match your SQLAlchemy dialect needs to be installed in your environment. For example, if using sqllite, pip install sqllite3. Additionally, SQLAlchemy dialects may need to be installed. For example, I've been successfully using etlalchemy with MS SQL Server using python-tds and sqlalchemy-pytds. For MySQL, I've been using pymysql.

If you like the idea of these changes, I'd be glad to update the readme and create a pull request for it. Let me know if you have other thoughts, too.

tpow commented 5 years ago

I went ahead and made the changes. See Pull Request #44.

Tim