https://github.com/mamerisawesome/coeusfactory

A Database Connector interface for Python 3 that follows a factory model pattern.
https://github.com/mamerisawesome/coeusfactory

List: coeusfactory

database database-factory db-connector python3

Last synced: 2 months ago
JSON representation

A Database Connector interface for Python 3 that follows a factory model pattern.

• Host: GitHub
• URL: https://github.com/mamerisawesome/coeusfactory
• Owner: mamerisawesome
• License: mit
• Created: 2020-02-13T03:53:22.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-28T11:25:16.000Z (about 6 years ago)
• Last Synced: 2026-04-03T10:47:06.556Z (3 months ago)
• Topics: database, database-factory, db-connector, python3
• Language: Python
• Homepage:
• Size: 74.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Coeus Factory - Database Connector Factory

[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)

[![PyPI pyversions](https://img.shields.io/pypi/pyversions/coeusfactory)](https://pypi.python.org/pypi/coeusfactory/)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/mamerisawesome/coeusfactory/graphs/commit-activity)

[![Coverage](https://raw.githubusercontent.com/mamerisawesome/coeusfactory/master/assets/coverage.svg?sanitize=true)](https://github.com/mamerisawesome/coeusfactory)

[![Awesome Badges](https://img.shields.io/badge/badges-awesome-green.svg)](https://github.com/Naereen/badges)

A Database Connector interface that follows a factory model pattern.

## Installation

```bash

# if using poetry

# highly recommended

poetry add coeusfactory

# also works with standard pip

pip install coeusfactory

```

Then add necessary database interfaces as necessary. Below are the libraries that works with Coeus Factory.

| Database | Python Library | Status            |

|----------|----------------|-------------------|

| **MongoDB**  | *pymongo*      | ![Passed unit tests](https://img.shields.io/static/v1?label=&message=Passed%20unit%20tests&color=green) |

| **DynamoDB** | *boto3*        | ![Needs unit tests](https://img.shields.io/static/v1?label=&message=Needs%20unit%20tests&color=yellow) |

## Getting Started

For every first step for any database, initialization and connections will come first. As long as it is supported in the factory, you can pass the parameters you normally handle in supported databse interfaces.

```python

from coeusfactory import ConnectorFactory

cf = ConnectorFactory(

    interface="",

    db=""

    # other config or auth params for the db

    username="",

    password=""

)

# db init

cf.handler.initialize()

cf.handler.connect()

```

## Connector Methods

### Getting / Creating a model

```python

Users = cf.get_model("Users")

Carts = cf.get_model("Carts")

CustomerReviews = cf.get_model("CustomerReviews")

```

### Retrieval

```python

Users.get_by_id(0)

Users.get({"name": "Test User"})

```

### Insertion

```python

Users.add({"name": "Test User"})

```

### Deletion

```python

Users.delete_by_id(0)

Users.delete({"name": "Test User"})

```

### Modification

```python

Users.update_by_id(0, {"name": "New Name"})

Users.update({"name": "Test User"}, {"name": "New Name"})

```

### Entry Count

```python

Users.count()

```

## Author

Almer Mendoza

[![Ask Me Anything !](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg)](mailto:atmalmer23@gmail.com)

[![ForTheBadge built-with-love](http://ForTheBadge.com/images/badges/built-with-love.svg)](https://GitHub.com/Naereen/)

[![forthebadge](https://forthebadge.com/images/badges/powered-by-responsibility.svg)](https://forthebadge.com)

[![forthebadge](https://forthebadge.com/images/badges/kinda-sfw.svg)](https://forthebadge.com)