{ "info": { "author": "Catalant Technologies", "author_email": "engineering@gocatalant.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Framework :: Flask", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 2 :: Only", "Programming Language :: SQL", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "CT Core DB\n###########\n\n.. _description:\n\nCT Core DB -- Catalant Core DB Framework.\n\nThe main features available in this framework include:\n\n- The **SQLAlchemy** toolkit with our customizations and enhancements\n- Commands for versioning and managing **MySQL** database schemas\n- Debugging and development utilities for working with SQLAlchemy queries and events\n\n.. _documentation:\n\n`SQLAlchemy Documentation`_\n\n.. _`SQLAlchemy Documentation`: http://http://www.sqlalchemy.org/\n\n.. _contents:\n\n.. contents::\n\n.. _requirements:\n\nRequirements\n=============\n\n- python >= 2.6\n- mysql-diff == 0.3 (built into the base Docker image)\n\n.. _installation:\n\nInstallation\n=============\n\n**CT Core DB** is hosted on our internal `PyPi repository`_. It should be installed using pip::\n\n pip install ct-core-db\n\n.. _PyPi repository: https://devpi.gocatalant.com/catalant/prod/ct-core-db\n\n.. _usage:\n\nUsage\n=====\n\nMost of the functionality exposed by this library is made available through the SQLAlchemy\n``ct_core_db.db`` instance or via the ``db`` Flask commands in ct-core-api_.\n\n.. _ct-core-api: https://github.com/Catalant/ct-core-api\n\nSQLAlchemy Enhancements\n```````````````````````\n- ``ct_core_db.lib.db_utils`` -- Various utilities for debugging and logging SQLAlchemy queries and events\n- ``ct_core_db.lib.sqla`` -- Improved signalling session that avoids PK collisions, base model, and model mixins\n- ``ct_core_db.lib.sqla_types`` -- Custom SQLAlchemy column data types\n\nMySQL Diff\n``````````\nUse the ``mysql_diff.MySQLDiffCommand`` to produce a database migration script based on the differences between two\nMySQL database schemas::\n\n from ct_core_db.lib import mysql_diff\n\n mysql_diff_cmd = mysql_diff.MySQLDiffCommand()\n diff_output = mysql_diff_cmd('jdbc_db_url_a', 'jdbc_db_url_b')\n\nMySQL Version Manager\n`````````````````````\nUse the ``mysql_version.MySQLVersionManager`` class to create, diff, and upgrade your MySQL database schemas::\n\n from ct_core_db.lib import mysql_diff\n\n mysql_version_manager = mysql_version.MySQLVersionManager(engine, mysql_diff_cmd)\n mysql_version_manager.init_db()\n mysql_version_manager.create_db()\n mysql_version_manager.diff_db() # Invokes `mysql_diff_command`\n mysql_version_manager.upgrade_db()\n\n.. _bugtracker:\n\nBug tracker\n===========\n\nIf you have any suggestions, bug reports or\nannoyances please report them to the issue tracker\nat https://github.com/catalant/ct-core-db/issues\n\n.. _contributing:\n\nContributing\n============\n\nDevelopment of ct-core-db happens at github: https://github.com/catalant/ct-core-db\n\n\nContributors\n=============\n\n* jcrafford_ (Justin Crafford)\n\n.. _license:\n\nLicense\n=======\n\nLicensed under a `MIT license`_.\n\n.. _links:\n\n.. _MIT license: https://opensource.org/licenses/MIT\n.. _jcrafford: https://github.com/jcrafford", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Catalant/ct-core-db", "keywords": "flask,sqlalchemy,db,database,validation", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "ct-core-db", "package_url": "https://pypi.org/project/ct-core-db/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/ct-core-db/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/Catalant/ct-core-db" }, "release_url": "https://pypi.org/project/ct-core-db/1.2.0/", "requires_dist": null, "requires_python": null, "summary": "Catalant Core DB Framework", "version": "1.2.0" }, "last_serial": 2477373, "releases": { "1.2.0": [ { "comment_text": "", "digests": { "md5": "5359d2661e314c338f0cd97ee7022200", "sha256": "825df147fa92cf9e98228dd304a32483deb998be9e6227458d2b9a2c014f3faf" }, "downloads": -1, "filename": "ct-core-db-1.2.0.tar.gz", "has_sig": false, "md5_digest": "5359d2661e314c338f0cd97ee7022200", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14416, "upload_time": "2016-11-22T21:22:53", "url": "https://files.pythonhosted.org/packages/15/0f/bef8a4e45f57cc12b2b8cc487130d3179a790bd3110522c52daa8e0a69ad/ct-core-db-1.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5359d2661e314c338f0cd97ee7022200", "sha256": "825df147fa92cf9e98228dd304a32483deb998be9e6227458d2b9a2c014f3faf" }, "downloads": -1, "filename": "ct-core-db-1.2.0.tar.gz", "has_sig": false, "md5_digest": "5359d2661e314c338f0cd97ee7022200", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14416, "upload_time": "2016-11-22T21:22:53", "url": "https://files.pythonhosted.org/packages/15/0f/bef8a4e45f57cc12b2b8cc487130d3179a790bd3110522c52daa8e0a69ad/ct-core-db-1.2.0.tar.gz" } ] }