https://github.com/heavenshell/py-sqlalchemy_seed

Simple data seeder using SQLAlchemy.
https://github.com/heavenshell/py-sqlalchemy_seed

python sqlalchemy

Last synced: about 1 year ago
JSON representation

Simple data seeder using SQLAlchemy.

• Host: GitHub
• URL: https://github.com/heavenshell/py-sqlalchemy_seed
• Owner: heavenshell
• License: bsd-3-clause
• Created: 2017-02-12T09:19:30.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-08-08T19:02:39.000Z (almost 4 years ago)
• Last Synced: 2024-09-14T22:24:23.598Z (almost 2 years ago)
• Topics: python, sqlalchemy
• Language: Python
• Homepage:
• Size: 73.2 KB
• Stars: 27
• Watchers: 5
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
sqlalchemy_seed

----------------

.. image:: https://github.com/heavenshell/py-sqlalchemy_seed/workflows/build/badge.svg

     :target: https://github.com/heavenshell/py-sqlalchemy_seed/actions?query=workflow%3Abuild

.. image:: https://pyup.io/repos/github/heavenshell/py-sqlalchemy_seed/python-3-shield.svg

     :target: https://pyup.io/repos/github/heavenshell/py-sqlalchemy_seed/

     :alt: Python 3

.. image:: https://pyup.io/repos/github/heavenshell/py-sqlalchemy_seed/shield.svg

     :target: https://pyup.io/repos/github/heavenshell/py-sqlalchemy_seed/

     :alt: Updates

`sqlalchemy_seed` is a seed library which provides initial data to database using SQLAlchemy.

`sqlalchemy_seed` is similar to `Django fixtures `_.

Installation

============

.. code::

  pip install sqlalchemy_seed

Adding seed

===========

.. code::

  /myapp

    __init__.py

    models.py

    /fixtures

      accounts.yaml

Model file.

.. code:: python

  # -*- coding: utf-8 -*-

  from sqlalchemy import create_engine

  from sqlalchemy.exc import OperationalError

  from sqlalchemy.ext.declarative import declarative_base

  from sqlalchemy.orm import scoped_session, sessionmaker, relationship

  engine = create_engine('sqlite://', convert_unicode=True)

  Base = declarative_base()

  Base.metadata.bind = engine

  Session = sessionmaker(autocommit=False, autoflush=False, bind=engine)

  session = scoped_session(Session)

  class Account(Base):

      __tablename__ = 'accounts'

      id = Column(Integer, primary_key=True)

      first_name = Column(String(100), nullable=False)

      last_name = Column(String(100), nullable=False)

      age = Column(Integer(), nullable=True)

Seed code.

.. code:: python

  # -*- coding: utf-8 -*-

  from sqlalchemy_seed import (

      create_table,

      drop_table,

      load_fixtures,

      load_fixture_files,

  )

  from myapp.models import Base, session

  def main():

      path = '/path/to/fixtures'

      fixtures = load_fixture_files(path, ['accounts.yaml'])

      load_fixtures(session, fixtures)

  if __name__ == '__main__':

      main()

Seed file.

.. code::

  - model: myapp.models.Account

    id: 1

    fields:

      first_name: John

      last_name: Lennon

      age: 20

  - model: myapp.models.Account

    id: 2

    fields:

      first_name: Paul

      last_name: McCartney

      age: 21

Update seed

===========

If you want idempotent, you can describe seed like followings.

Seed file.

.. code::

  - model: myapp.models.Account

    fields:

      id: 1

      first_name: John

      last_name: Lennon

      age: 20

  - model: myapp.models.Account

    fields:

      id: 2

      first_name: Paul

      last_name: McCartney

      age: 21

LICENSE

=======

NEW BSD LICENSE.