Meta tags:
description=🚀 Performance, type safety, and elegance. A next-generation async Python framework for APIs, microservices, and web applications. 🚀;

Headings (most frequently used words):

py, ravyn, support, start, concepts, larger, installation, project, the, features, accounts, urls, style, recommended, for, quick, documentation, paths, why, core, organizing, applications, additional, options, with, scaffolding, next, steps, requirements, about, join, community, sponsors, your, first, api, run, it, explore, docs, key, routes, and, handlers, dependency, injection, settings, management, structure, controllers, app, testing, jwt, scheduler, interactive, shell, essential, building, going, to, production, history, motivation, powered, by, decorator, simple, apis, gateway, apps,

Text of the page (most frequently used words):
ravyn (66), and (33), app (21), for (19), the (18), your (16), api (16), from (16), #gateway (14), get (13), testing (12), routes (12), #concepts (11), import (11), return (11), with (10), support (10), settings (10), application (10), routing (10), users (10), accounts (10), you (9), project (9), features (9), responses (9), start (9), def (9), more (8), about (8), middleware (8), jwt (8), urls (8), dict (8), learn (7), controllers (7), permissions (7), documentation (7), docs (7), openapi (7), deployment (7), first (7), pip (7), install (7), name (7), jsonresponse (7), dependency (6), injection (6), built (6), request (6), test (6), dependencies (6), recommended (6), shell (6), handlers (6), core (6), guides (6), structure (5), esmerald (5), data (5), configuration (5), background (5), directives (5), simple (5), scheduler (5), post (5), myapp (5), include (5), str (5), applications (5), style (5), requests (5), are (4), sponsors (4), django (4), motivation (4), use (4), next (4), python (4), environment (4), production (4), tasks (4), database (4), response (4), advanced (4), this (4), learning (4), interactive (4), authentication (4), installation (4), create_account (4), list_accounts (4), handler (4), larger (4), uses (4), palfrey (4), quick (4), type (4), here (4), tutorials (4), how (4), reference (4), http (4), 127 (4), 8000 (4), hello (4), file (4), utilities (4), security (4), parameters (4), github (3), join (3), models (3), flask (3), management (3), design (3), fastapi (3), while (3), framework (3), lilya (3), requirements (3), run (3), async (3), add (3), building (3), explore (3), generate (3), apps (3), basics (3), task (3), options (3), create (3), ravyn_settings_module (3), reload (3), developmentsettings (3), inject (3), decorators (3), list_users (3), decorator (3), apis (3), swagger (3), client (3), mongoz (3), edgy (3), world (3), workflows (3), path (3), message (3), dymmond (3), files (3), query (3), oauth2 (3), fields (3), examples (3), powered (2), one (2), latest (2), source (2), community (2), nestjs (2), solve (2), gaps (2), was (2), best (2), rebranded (2), generation (2), history (2), pydantic (2), high (2), performance (2), asgi (2), going (2), integration (2), types (2), patterns (2), essential (2), now (2), that (2), running (2), these (2), steps (2), ready (2), createproject (2), myproject (2), scaffold (2), enterprise (2), continue (2), scaffolding (2), ipython (2), ptpython (2), schedulers (2), based (2), additional (2), organized (2), route_patterns (2), created (2), into (2), organizing (2), development (2), environmenttype (2), dev (2), ravynsettings (2), guide (2), get_database (2), injects (2), prototypes (2), bob (2), alice (2), always (2), hints (2), define (2), automatically (2), choose (2), key (2), why (2), paths (2), elements (2), redoc (2), welcome (2), https (2), release (2), interceptors (2), extensions (2), exceptions (2), template (2), base (2), static (2), csrf (2), cors (2), configurations (2), router (2), context (2), shortcuts (2), contrib (2), cli (2), example (2), mongodb (2), sql (2), integrations (2), introduction (2), caching (2), auth (2), logging (2), body (2), forms (2), architecture (2), troubleshooting (2), getting (2), started (2), build (2), made, zensical, jetbrains, worth, mentioning, who, helping, currently, there, but, can, financially, help, author, though, become, legend, special, updates, follow, twitter, ask, questions, share, projects, our, discord, show, star, open, love, contribution, transformers, signature, starlite, simplicity, flexibility, automatic, frameworks, like, common, problems, they, sometimes, leave, business, logic, organization, fill, those, keeping, evolution, align, growing, ecosystem, tools, its, specific, cases, represents, improved, consistency, future, focused, continues, exist, validation, customize, deploy, connect, databases, secure, endpoints, processing, different, master, have, topics, setup, sample, pre, configured, creates, complete, comfortable, structures, new, warning, scheduling, includes, ravyntestclient, namespace, grows, organize, modules, set, sensible, defaults, env, windows, macos, linux, load, via, variable, true, bool, debug, app_name, class, conf, enums, inspired, db_status, connected, any, level, wide, individual, scalable, tip, create_user, specify, validate, accurate, serialize, correctly, important, empty, does, nothing, must, handle, least, route, required, critical, objects, generated, auto, documented, easy, testable, native, odm, orm, batteries, included, oop, functional, mix, both, flexible, full, better, ide, fewer, bugs, safe, fast, combines, ideas, designed, real, systems, flowchart, developer, standardize, team, process, look, signatures, understand, internals, concrete, progressively, matches, current, goal, congratulations, stoplight, generates, visit, see, greet, called, installs, extras, also, need, server, standard, minutes, came, looking, right, place, all, remain, grow, coming, official, supported, version, released, com, code, microservices, web, safety, elegance, page, notes, migration, contributing, contributors, sponsorship, websockets, status, codes, pluggables, injector, uploadfile, stream, redirect, openapiresponse, templateresponse, ujsonresponse, ujson, orjsonresponse, orjson, json, session, websocket, webhook, view, abort, cqrs, command, responsibility, segregation, jsonify, send, mail, external, wsgi, exception, directive, custom, discovery, documents, scaling, docker, grpc, experimental, relay, protocols, msgspec, encoders, lifespan, events, observables, introspection, password, hashers, available, scopes, basic, interaction, templates, sessions, cookie, header, uploads, webhooks, levels, cookies, headers, upload, strategies, bit, middlewares, error, handling, debugging, local, loop, flow, component, interactions, lifecycle, system, observability, large, bootstrap, beginner, search, русский, язык, english, skip, content,

Text of the page (random words):
ravyn ravyn skip to content ravyn ravyn en english ru русский язык search dymmond ravyn ravyn dymmond ravyn start here start here learning and examples beginner quick start troubleshooting tutorials tutorials build a production api build a production api bootstrap project routing and models auth and permissions testing and deployment how to guides how to guides add jwt authentication structure a large project add observability and logging concepts concepts system architecture request lifecycle component interactions data flow workflows workflows local development loop testing debugging and release learning and examples learning and examples getting started getting started first api request response error handling routing basics middlewares background tasks dependencies requests and responses a bit more about routing troubleshooting advanced guides advanced guides security patterns deployment basics architecture dependency injection advanced concepts caching strategies path parameters query parameters request data upload files forms body headers cookies core concepts core concepts application application ravyn settings levels routing routing routes handlers controllers router webhooks requests responses requests responses requests responses path parameters query parameters request data file uploads forms body fields header fields cookie fields dependencies context configuration configuration cors csrf sessions static files templates logging jwt scheduler openapi security security introduction interaction oauth2 jwt simple oauth2 basic auth oauth2 scopes available security password hashers features features introspection middleware middleware authentication permissions permissions ravyn lilya interceptors observables background tasks caching lifespan events scheduler scheduler configuration task handlers decorators encoders msgspec protocols extensions relay experimental features grpc testing deployment testing deployment testing testing test client testing guide deployment deployment introduction docker scaling database integrations database integrations edgy sql edgy sql motivation models middleware example mongoz mongodb mongoz mongodb motivation documents middleware example openapi openapi openapi interactive api documentation cli directives cli directives discovery built in directives custom directives directive decorator shell utilities utilities exceptions exception handlers wsgi integration external contrib contrib mail send file jsonify cqrs command query responsibility segregation shortcuts shortcuts abort responses api reference api reference core core ravyn application request context test client routing routing router gateway handlers include view webhook gateway websocket gateway configurations configurations cors csrf jwt openapi session static files template middleware middleware base authentication responses responses base response json jsonresponse orjson orjsonresponse ujson ujsonresponse template templateresponse openapiresponse redirect stream file utilities utilities exceptions uploadfile background extensions injector interceptors permissions pluggables status codes websockets about about about ravyn sponsorship contributors contributing migration release notes on this page quick start installation your first api run it explore the docs documentation paths why ravyn key features core concepts routes and handlers decorator style recommended for simple apis gateway style recommended for larger apps dependency injection settings management organizing larger applications project structure accounts controllers py accounts urls py urls py app py additional installation options testing support jwt support scheduler support interactive shell start a project with scaffolding next steps essential concepts building features going to production requirements about ravyn history motivation join the community sponsors powered by ravyn start here ravyn a next generation async python framework for building high performance apis microservices and web applications with type safety and elegance documentation https ravyn dev source code https github com dymmond ravyn the official supported version is always the latest released coming from esmerald if you came looking for esmerald you are in the right place esmerald was rebranded to ravyn all features remain and continue to grow quick start get your first ravyn api running in minutes installation pip install ravyn standard this installs ravyn with recommended extras you ll also need an asgi server pip install palfrey your first api create a file called app py from ravyn import ravyn get jsonresponse app ravyn app get def welcome jsonresponse return jsonresponse message welcome to ravyn app get hello name def greet name str jsonresponse return jsonresponse message f hello name run it palfrey app app reload visit http 127 0 0 1 8000 hello world and you ll see message hello world explore the docs ravyn automatically generates interactive api documentation swagger ui http 127 0 0 1 8000 docs swagger redoc http 127 0 0 1 8000 docs redoc stoplight elements http 127 0 0 1 8000 docs elements congratulations you ve built your first ravyn api documentation paths choose the path that matches your current goal learn progressively tutorials solve a concrete task how to guides understand internals concepts look up signatures and options api reference standardize team process developer workflows flowchart lr a start here b tutorials a c how to guides a d concepts d e api reference b c why ravyn ravyn combines the best ideas from fastapi django flask and nestjs into a framework designed for real world applications from prototypes to enterprise systems key features fast built on lilya and pydantic with async first design type safe full python 3 10 type hints for better ide support and fewer bugs flexible choose oop controllers or functional style or mix both batteries included dependency injection middleware permissions schedulers and more database ready native support for edgy orm and mongoz odm testable built in test client for easy testing auto documented openapi swagger docs generated automatically core concepts routes and handlers ravyn uses decorators or gateway objects to define routes critical requirements at least one route is required an empty ravyn application does nothing you must define routes to handle requests return types are important always specify return type hints e g dict jsonresponse ravyn uses these to serialize your data correctly generate accurate api documentation validate responses decorator style recommended for simple apis from ravyn import ravyn get post app ravyn app get users def list_users dict return users alice bob app post users def create_user name str dict return created name gateway style recommended for larger apps from ravyn import ravyn gateway get get def list_users dict return users alice bob app ravyn routes gateway users handler list_users tip use decorators for quick prototypes use gateway include for scalable organized applications dependency injection inject dependencies at any level from application wide to individual routes from ravyn import ravyn gateway inject injects get def get_database return db connected get def users db dict injects dict return users db_status db app ravyn routes gateway users handler users dependencies db inject get_database learn more in the dependencies guide settings management ravyn uses environment based settings inspired by django from ravyn import ravynsettings from ravyn conf enums import environmenttype class developmentsettings ravynsettings app_name str my app dev environment str environmenttype development debug bool true load your settings via environment variable macos linux ravyn_settings_module myapp settings developmentsettings palfrey app app reload windows env ravyn_settings_module myapp settings developmentsettings palfrey app app reload if no ravyn_settings_module is set ravyn uses sensible defaults learn more in application settings organizing larger applications as your app grows use include to organize routes into modules project structure myapp app py urls py accounts controllers py urls py accounts controllers py from ravyn import get post get def list_accounts dict return accounts post def create_account name str dict return created name accounts urls py from ravyn import gateway from controllers import list_accounts create_account route_patterns gateway handler list_accounts gateway create handler create_account urls py from ravyn import include route_patterns include accounts namespace myapp accounts urls app py from ravyn import ravyn app ravyn routes myapp urls now your routes are organized get accounts list_accounts post accounts create create_account learn more in routing additional installation options testing support pip install ravyn test includes the ravyntestclient for testing your application jwt support pip install ravyn jwt for jwt based authentication scheduler support pip install ravyn schedulers for background task scheduling interactive shell pip install ipython ipython shell pip install ptpython ptpython shell learn more about the shell start a project with scaffolding warning this is for users comfortable with python project structures if you re new to ravyn continue learning the basics first generate a simple project scaffold ravyn createproject myproject simple or generate a complete scaffold recommended for enterprise apps ravyn createproject myproject this creates a ready to go structure with pre configured application sample routes test setup learn more in directives next steps now that you have ravyn running explore these topics essential concepts dependencies master dependency injection routing advanced routing patterns responses different response types testing test your application building features middleware add request response processing permissions secure your endpoints database integration connect to databases background tasks run async tasks going to production settings environment configuration deployment deploy your application openapi configuration customize api docs requirements python 3 10 ravyn is built on lilya high performance asgi framework pydantic data validation about ravyn history ravyn is the evolution of esmerald rebranded to align with a growing ecosystem of tools esmerald continues to exist for its specific use cases while ravyn represents the next generation with improved consistency and future focused design motivation while frameworks like fastapi flask and django solve 99 of common problems they sometimes leave gaps in structure and business logic organization ravyn was built to fill those gaps while keeping the best features from fastapi api design and automatic documentation django permissions and settings management flask simplicity and flexibility nestjs controllers and dependency injection starlite transformers and signature models learn more in about ravyn join the community ravyn is an open source project and we love your contribution star us on github to show your support ️ join our discord to ask questions and share your projects follow us on x twitter for the latest updates sponsors currently there are no sponsors of ravyn but you can financially help and support the author though github sponsors and become a special one or a legend powered by worth mentioning who is helping us jetbrains made with zensical