Metadata-Version: 2.1
Name: everstone
Version: 0.1.2
Summary: Simple Database Query Generator
Home-page: https://github.com/scragly/everstone
License: MIT
Keywords: sql,query,generator,simple
Author: scragly
Author-email: 29337040+scragly@users.noreply.github.com
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: SQL
Classifier: Topic :: Database
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Dist: asyncpg (>=0.22.0,<0.23.0)
Project-URL: Repository, https://github.com/scragly/everstone
Description-Content-Type: text/markdown

# everstone

A simple database query generator.


### This project is still in active develpment and is not ready of usage.

## Installation
```sh
pip install everstone
```

**Requires Python 3.9.0+**

## Usage

### Connecting a Database
```py
from everstone import db

db.connect("test_database", "user_one", "abcd5432")
```

### Creating a Schema:

```python
from everstone import db

auth_schema = db.Schema("auth")
await auth_schema.create()
```
#### Resulting SQL
```sql
CREATE TABLE user (user_id INTEGER PRIMARY KEY, name TEXT);
```

### Creating a Table:

```py
from everstone import constraints, db, types
from everstone import Column
user_table = db.Table("user")
user_table.add_columns(
    Column("user_id", types.Integer, constraints.PrimaryKey),
    Column("name", types.Text)
)
await user_table.create()
```
#### Resulting SQL
```sql
CREATE TABLE user (user_id INTEGER PRIMARY KEY, name TEXT);
```

