common -> pygarden

# Common Package

# pyGARDEN Package

Code for the Common Python Package to include logging, environment checking, 

and database connections and query. This package contains an extensible 

Database metaclass with a generic query function that is usable out of the box. 

Everything is configurable with environmental variables.

Code for the pyGARDEN (**G**eneral **A**pplication **R**esource **D**evelopment **E**nvironment **N**etwork) Python Package to include easy injectable and rich logging, environment checking, and database 

connections and query. By default, only SQLite is available as a mixin, but other mixin types to the `Database` class 

are Postgres (`[postgres]` extra) or Microsoft SQL Server (`[mssql]` extra). See the [extras](#Extras) section for more

information on how to install these extras, when to choose them, and how to use them.

Some highlights from `pyGARDEN`: 

* This package contains an extensible `Database` metaclass with a generic query function that is usable out of the box. 

* Everything is configurable with environmental variables -- including email sending, logging, and database connections.

* 

### Installation via pip

- DATABASE_PORT, PG_PORT: an integer representing the port to connect to the database on

- DATABASE_SCHEMA, PG_SCHEMA: a string representing the schema to default to when creating a database connection

These evironmental variables have been assigned default values for the Docker container in the file `envfile`, which is called in `docker-compose.yaml` and `docker-compose.test.yaml`

These environmental variables have been assigned default values for the Docker container in the file `envfile`, which is called in `docker-compose.yaml` and `docker-compose.test.yaml`

### Creating an extensible Database Python Class

Some `Database` methods such as `query` and `open` rely on

example of how to create a Database class that uses the PostgresMixin:

```python

from common.mixins.postgres import PostgresMixin

from common.database import Database

from pygarden.mixins.postgres import PostgresMixin

from pygarden.database import Database

class PostgresDatabase(Database, PostgresMixin):

### Creating a CRUD table with crud_table.py

```python

from common.mixins.postgres import PostgresMixin

from common.database import Database

from common.crud_table import CRUDTable

from pygarden.mixins.postgres import PostgresMixin

from pygarden.database import Database

from pygarden.crud_table import CRUDTable

# PLEASE NOTE: the name of class MUST be consistent with the name of the

# table in the database itself.

class users(CRUDTable):

class Users(CRUDTable):

    """Provides CRUD access to the users table"""

    def __init__(self, db):

    """__init__:

FROM --platform=linux/amd64 python:3.11-slim

ARG GITLAB_TOKEN=3t2LFTptHcudHsKRsgr8

ARG COMMON_VERSION=0.3.1

ARG COMMON_VERSION=0.3.7

ARG COMMON_EXTRAS="postgres"

RUN apt-get -yqq update && apt-get install -yqq postgresql-client

RUN pip install common-package[all]==$COMMON_VERSION --index-url https://__token__:$GITLAB_TOKEN@code.ornl.gov/api/v4/projects/10568/packages/pypi/simple

RUN pip install common-package[$COMMON_EXTRAS]==$COMMON_VERSION --index-url https://__token__:$GITLAB_TOKEN@code.ornl.gov/api/v4/projects/10568/packages/pypi/simple

CMD ["tail", "-f", "/dev/null"]

 No newline at end of file

#!/usr/bin/env python3

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

"""

Common package to assist in rapid package development.

pyGARDEN (General Application Resource Development Environment Network) to assist in rapid package development.

"""

from typing import Any, Callable, Dict

from urllib.parse import urlencode, urlparse

from common.env import check_environment as ce

from pygarden.env import check_environment as ce

try:

    from ldap3 import ALL, SUBTREE, Connection, Server

except ImportError:

    import sys

    from common.logz import create_logger

    from pygarden.logz import create_logger

    log = create_logger()

    log.warn("To use this module, install common-package[auth] extra.")