Skip to content

Commit

Permalink
First Showcase
Browse files Browse the repository at this point in the history
Implements the main action that we can do inside a ORM: create a model.
  • Loading branch information
pochecho committed May 17, 2020
1 parent dff939a commit c20771c
Show file tree
Hide file tree
Showing 10 changed files with 191 additions and 464 deletions.
49 changes: 48 additions & 1 deletion README.md
@@ -1,3 +1,50 @@
# full_alchemyst
Let's you to use both SqlAlchemyst and MongoAlchemyst libraries
Les's to use a unique ORM to manage the persistence in one project.
Les's to use a unique ORM to manage the persistence in one project.

## How to Use?
You need to configurate a dictionary with the next parameters:
db_config = {
"type":"mongo",
"host": "localhost",
"port":27017,
"user":"",
"database":"google",
"password":"",
"SQLALCHEMY_TRACK_MODIFICATIONS":True
}

- *** type: *** mongo | mysql
- *** host: *** Host where the database is
- *** port: *** Port of engine runs
- *** user: *** User
- *** databse: *** Name of database
- *** password: *** Password

How you see, you can to specify other attributes of the ORM, like "SQLALCHEMY_TRACK_MODIFICATIONS".

After to set the configuration that you want to use, you have to create a FullAlchemyst instance:

```
app = Flask(__name__)
fullAlchemyst= FullAlchemyst(app,db_config)
```

Obviusly, What is a ORM without models? Create one:

```
class task(fullAlchemyst.Entity):
id = define(fullAlchemyst.db, {"name":"id","type":"int","primary_key":True})
nombre = define(fullAlchemyst.db, {"name":"nombre","type":"str"})
```

### Steps:
1. First, you need to extend you model of fullAlchemyst.Entity
2. Define your attributes. In this step, remember to use the "define" function. We see this later

### "define" function
This function is used to configurate you model depending what type of database you use.

This function, receives a dict, and its structure is the next:
- type : int | str o another inside de buildins of python.
- primary_key : If you attribute is a primary key.
136 changes: 0 additions & 136 deletions app_mongo.py

This file was deleted.

67 changes: 0 additions & 67 deletions app_mysql.py

This file was deleted.

9 changes: 0 additions & 9 deletions db.config-mongo.json

This file was deleted.

9 changes: 0 additions & 9 deletions db.config-mysql.json

This file was deleted.

21 changes: 0 additions & 21 deletions full_alchemyst/abstract_methods.py

This file was deleted.

21 changes: 0 additions & 21 deletions full_alchemyst/driver.config.json

This file was deleted.

0 comments on commit c20771c

Please sign in to comment.