alchemyrohan 0.5.0

Is a helpful tool for creating SqlAlchemy models.

Alchemyrohan

Alchemyrohan is a helpful tool for creating SqlAlchemy models based on the database schema.

---

📖 Content

• How to Install
• Database Support
• How to use
  • In Command-Line
  • As Script
    • Functions
      • Main Function
      • Optional Function
• Models
• Dependencies
• Important Note
• Release Notes
• License

---

🔧 How to Install

With pip package installer from PyPI directly:

pip install alchemyrohan

or from source:

pip install pdm
git clone https://github.com/wamberger/alchemyrohan.git
pdm install

🗄 Database Support

This project is currently designed to work with the following databases:

• SqLite
• Oracle

🔨 How to use

⌨️ In Command-Line

You can execute the tool by entering the command along with its arguments:

usage: arohan [-h] -c CONN_STR [-p PATH] [-y PY_PATH] -m MODELS

options:
  -h, --help            show the help message and exit
  -c CONN_STR, --conn_str CONN_STR
                        Connection string to connect with the database - Required argument. 
                        Accepts a string.
  -p PATH, --path PATH  Path where to save the models - Optional argument. 
                        Defaults to the current working directory. Accepts a string.
  -y PY_PATH, --py_path PY_PATH
                        Pythonic path to models in the project. Optional argument. 
                        Defaults to 'py_path'. Accepts a string.
  -m MODELS, --models MODELS
                        Names of the database tables. Required argument. Add every table with -m=

Example:

arohan -c=sqlite:////path/to/your/database/test.db  -y=py.path.to.models -p=path/to/models/ -m=table1 -m=table2 -m=tables3

💻 As Script

You can find an example script in the directory help_file/.

🪄 Functions

🔮 Main Function

assemble_models() is the main function. This function is used to create a SqlAlchemy database model and is accepting the following arguments:

argument	description
conn_str	Credential string to connect to the database
table_names	Names of the tables
path	Absolute path to the location where the created models will be saved
py_path	pythonic path to the models

Simple example how to use the function assemble_models():

import os

from sqlalchemy.exc import SQLAlchemyError
import alchemyrohan as ar


def main() -> None:

    path = os.path.dirname(__file__)

    # Sqlite example
    conn_str = f"sqlite:///{path}{os.sep}test_sqlite{os.sep}test.db"
    # Oracle-Database example
    # db_creds = f'oracle+oracledb://{username}:{password}@{hostname}:{port}/{service_name}'

    path = os.path.join(path, 'test_models') # path to save models
    py_path = 'tests.test_models' # pythonic path to models

    table_names = ['parent', 'child'] # all names will be capitilized

    try:
        ar.assemble_models(conn_str, table_names, path, py_path)
    except SQLAlchemyError as e:
        raise SQLAlchemyError(e) from e


if __name__ == '__main__':
    main()

💉 Optional Function

get_model(): It retrieves the desired database object of the SqlAlchemy model. It requires the table_name and py_path_to_model arguments.

import alchemyrohan as ar

model = ar.get_model('child', 'py.path.to.model')

🗂 Models

Created SqlAlchemy models have some additional features:

• Default values.
• Parent-child relationships.
• When 'printing', the string will contain the model/object name and attribute names with their values.

All models are named with the same convention as they are in the database, with one difference: they are capitalized according to Python class naming conventions.

Example of one created model:

from sqlalchemy import Column
from tests.test_models import Base
from sqlalchemy import ForeignKey
from sqlalchemy.dialects.sqlite import INTEGER
from sqlalchemy.dialects.sqlite import TEXT
from sqlalchemy.orm import relationship


class Child(Base):
    __tablename__ = 'child'


    id = Column(INTEGER, primary_key=True)
    parent_id = Column(INTEGER, ForeignKey('parent.id'), nullable=True, default=None)
    name = Column(TEXT, nullable=True, default=None)
    grade = Column(INTEGER, nullable=True, default=None)


    parent_Parent = relationship("Parent", back_populates="children_Child", lazy="joined")
    
    def __str__(self):

        return (f'User(id={self.id},'
			f'parent_id={self.parent_id},'
			f'name={self.name},'
			f'grade={self.grade})')

📚 Dependencies

• sqlalchemy (version 2.x.x) is an ORM and provides code for its models.
• oracledb (version 2.x.x) is used to shape a database table model with an Oracle table schema.

❗Important Note

You should always check the code and correct it manually if necessary. This may be necessary in cases when:

• You add the wrong path.

• You are creating only one model which has relationships to other tables, thus you will need to create those models or delete the relevant part of the code.

• Your tables have no primary keys. SQLAlchemy requires at least one primary key.

• Your database may have some data types or features which have not yet been tested - Please report!

📋 Release Notes

• v0.5.0:

  • code refactor.
  • The 'validate' method has been removed from the created models and is no longer available.
  • Updated README.md.

• v0.4.1 - Some vital changes! Please look at CHANGELOG.md. In short:

  • New command-line: arohan.
  • Removed functions: is_model(), reload_module(), is_module().
  • Changing parameter names in the function assemble_models().
  • Bug fixing (relationship).
  • In models, method validate.

• v0.4.0 - Main update! Not compatible with previous versions. Changes:

  • Changed function name from assemble_model() to assemble_models().
  • Updated parameters of the assemble_models() function.
  • Revised code structure of the assemble_models() function.
  • Adjusted naming or added text in utils.py, wizard.py and __init__py.
  • Updated README.md file.

• v0.3.2 - text fixing and adding third party licenses

• v0.3.1 - bug fixing

• v0.3.0 - added additional functions

• v0.2.0 - tested with Oracle database

• v0.1.0 - creation of the initial code and tested with SqLite database

📄 License and Third-Party Licenses

Alchemyrohan is MIT licensed, as stated in the LICENSE file.

The following software components are included in this project:

• SqlAlchemy (MIT License)
• python-oracledb (Apache License 2.0)

THIRD PARTY LICENSES