0.2.33

Author: victorteokw

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "teo-py"
-version = "0.2.32"
+version = "0.2.33"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -9,7 +9,7 @@ name = "teo"
 crate-type = ["cdylib"]
 
 [dependencies]
-teo = { version = "0.2.32" }
+teo = { version = "0.2.33" }
 teo-result = { version = "0.2.23", features = ["pyo3"] }
 pyo3 = { version = "0.20.3", features = ["extension-module", "chrono", "indexmap"] }
 pyo3-asyncio = { version = "0.20.0", features = ["attributes", "tokio-runtime"] }

Cargo.toml

@@ -1,25 +1,192 @@
-Teo Python
-==========
+<div align="center">
+  <h1>Teo</h1>
+  <a href="https://crates.io/crates/teo"><img src="https://img.shields.io/crates/v/teo?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/@teocloud/teo"><img src="https://img.shields.io/npm/v/%40teocloud%2Fteo?style=flat-square" /></a>
+  <a href="https://pypi.org/project/teo/"><img src="https://img.shields.io/pypi/v/teo?style=flat-square" /></a>
+  <a href="https://marketplace.visualstudio.com/items?itemName=yeannylam.teo-vscode"><img src="https://img.shields.io/visual-studio-marketplace/v/yeannylam.teo-vscode?style=flat-square&label=VSCode%20marketplace&color=%2300AFD7" /></a>
+  <a href="https://github.com/teocloud/teo/blob/master/LICENSE"><img src="https://img.shields.io/github/license/teocloud/teo.svg?style=flat-square" /></a>
+  <a href="https://github.com/teocloud/teo"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" /></a>
+  <br />
+  <br />
+  <div><strong>Schema-centered</strong> next-generation web framework for Rust, Node.js and Python.</div>
+  <br />
+  <a href="https://docs.teodev.io/getting-started/quickstart">Quickstart</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://teodev.io/">Official website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://docs.teodev.io/">Docs</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://blog.teodev.io">Blog</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://teodev.io/discord">Discord</a>
+  <br />
+  <hr />
+</div>
 
-Run Teo server and write custom callbacks with Python.
+## Introduction
 
-## Installation
+Teo is a **schema-centered** next-generation web framework for Rust, Node.js and Python.
+
+## Highlights & Features
+
+* Innovative schema definition inspired by GraphQL and Prisma
+* Auto database migration
+* Supports Rust, Node.js and Python
+* Supports MySQL, PostgreSQL, SQLite and MongoDB
+* Generated ORM types and interfaces
+* Generated query clients for frontend
+* Very efficient and performant
+* Data sanitization, transformation and validation
+* Builtin user sessions
+* Builtin permission check
+* First in last out middlewares
+* Custom routes and handlers
+* Generated customizable admin dashboard
+
+## Getting started
+
+The fastest way to get started with Teo is by following the [Quickstart guide](https://docs.teodev.io/getting-started/quickstart).
+
+### Installation
+
+Install Node.js edition.
+
+```sh
+npm install @teocloud/teo
+```
+
+Install Python edition.
 
 ```sh
 pip install teo
 ```
 
-## Example
+Install Rust edition.
 
-```python
-from asyncio import run
-from teo import App
+```sh
+cargo install teo
+```
+
+### Write a schema-only server
+
+To write a server is quite simple with Teo. Create a file named `schema.teo`.
+Specify which database to connect and which port to listen.
+
+```teo
+connector {
+  provider: .sqlite,
+  url: "sqlite::memory:"
+}
+ 
+server {
+  bind: ("0.0.0.0", 5050)
+}
+ 
+model User {
+  @id @autoIncrement @readonly
+  id: Int
+  @unique @onSet($if($presents, $isEmail))
+  email: String
+  name: String?
+  @relation(fields: .id, references: .authorId)
+  posts: Post[]
+}
+ 
+model Post {
+  @id @autoIncrement @readonly
+  id: Int
+  title: String
+  content: String?
+  @default(false)
+  published: Bool
+  @foreignKey
+  authorId: Int
+  @relation(fields: .authorId, references: .id)
+  author: User
+}
+```
+
+Start the server with `teo serve` command. Now you can create, update, delete,
+read, aggregate and group by. Read our
+[Query client guide](https://docs.teodev.io/guides/query-client-guides/crud)
+for detailed usage.
+
+### Write custom handlers
 
+Declare the handler in the schema.
 
+```teo
+@map(.get, "/echo/:data", interface: "EchoPathArguments")
+declare nonapi handler echo(): Any
+```
+
+Implement the handler with program code.
+
+#### Node.js implementation
+
+```ts
+import { App, Response, RequestCtx } from '@teocloud/teo'
+import { EchoPathArguments } from './entities'
+ 
+const app = new App()
+app.mainNamespace().defineHandler("echo", (ctx: RequestCtx) => {
+    const pathArguments: EchoPathArguments = ctx.pathArguments()
+    return Response.string(pathArguments.data, "text/plain")
+})
+app.run()
+```
+
+#### Python implementation
+
+```python
+from asyncio import run
+from teo import App, Response, RequestCtx
+from entities import EchoPathArguments
+ 
 async def main():
     app = App()
+    def echo_handler(ctx: RequestCtx):
+        path_arguments: EchoPathArguments = ctx.path_arguments()
+        return Response.string(path_arguments["data"], "text/plain")
+    app.main_namespace().define_handler("echo", echo_handler)
     await app.run()
+ 
+run(main())
+```
 
+#### Rust implementation
 
-run(main())
+```rust
+mod entities;
+ 
+use tokio::main;
+use teo::prelude::{App, Response, Result, path};
+use crate::entities::EchoPathArguments;
+ 
+#[main]
+async fn main() -> Result<()> {
+    let app = App::new()?;
+    app.main_namespace_mut().define_handler("echo", |path_args: EchoPathArguments| async move {
+        Ok::<Response, Error>(Response::string(path_args.data(), "text/plain"))
+    });
+    app.run().await
+}
 ```
+
+## Tutorials
+
+We prepared a [Beginner tutorial series](https://docs.teodev.io/getting-started/beginner-tutorial/write-a-schema-only-app)
+to help you learn and understand Teo.
+
+## Issues
+
+Welcome to submit issues in this repo.
+
+## Contributing
+
+Read our [Contributing guide](https://github.com/teocloud/teo/blob/main/CONTRIBUTING.md)
+to set projects up and start contributing.
+
+## License
+
+TEO is under Apache 2.0 license.