initial commit

Author: collerek

.gitignore

@@ -109,6 +109,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+p38venv/
 
 # Spyder project settings
 .spyderproject

.idea/.gitignore

@@ -1,2 +1,46 @@
 # sqlalchemy-to-ormar
-Simple translator from sqlalchemy ORM models to ormar models
+
+# **WORK IN PROGRESS**
+
+Simple translator from `sqlalchemy` ORM models to `ormar` models.
+
+The `ormar` package is an async mini ORM for Python, with support for **Postgres,
+MySQL**, and **SQLite**. 
+
+To learn more about ormar:
+
+*  ormar [github][github]
+*  ormar [documentation][documentation]
+
+## Supported fields
+
+`sqlalchemy-to-ormar` supports following sqlachemy field types:
+
+* "integer": `ormar.Integer`,
+* "small_integer": `ormar.Integer`,
+* "big_integer": `ormar.BigInteger`,
+* "string": `ormar.String,`
+* "text": `ormar.Text,`
+* "float": `ormar.Float,`
+* "decimal": `ormar.Decimal,`
+* "date": `ormar.Date,`
+* "datetime": `ormar.DateTime,`
+* "time": `ormar.Time,`
+* "boolean": `ormar.Boolean`
+
+## Supported relations
+
+sqlalchemy-to-ormar supports both `ForeignKey` as well as `ManyToMany` relations
+
+## Known limitations
+
+sqlalchemy to ormar right now does not support:
+
+* composite (multi-column) primary keys and foreign keys (as ormar does not support
+  them yet)
+* ManyToMany fields names customization (as ormar does not support them yet)
+* Model inheritance
+
+
+[documentation]: https://collerek.github.io/ormar/
+[github]: https://github.com/collerek/ormar

.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,23 @@
+ormar
+sqlalchemy<=1.3.23
+databases
+
+# tests
+pytest
+pytest-cov
+codecov
+
+mypy
+
+# lint
+flake8
+flake8-black
+flake8-bugbear
+flake8-import-order
+flake8-bandit
+flake8-annotations
+flake8-builtins
+flake8-variables-names
+flake8-cognitive-complexity
+flake8-functions
+flake8-expression-complexity