You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .docs/commands.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,46 +1,46 @@
1
-
# Cotlette Management Commands
1
+
# Raystack Management Commands
2
2
3
3
## Overview
4
4
5
-
Cotlette provides a set of command-line tools for project management, similar to Django's `manage.py` or Flask CLI. These commands help you create projects, apps, run the development server, and more.
5
+
Raystack provides a set of command-line tools for project management, similar to Django's `manage.py` or Flask CLI. These commands help you create projects, apps, run the development server, and more.
6
6
7
7
---
8
8
9
9
## Available Commands
10
10
11
11
### `startproject <project_name>`
12
-
Creates a new Cotlette project with the recommended structure.
12
+
Creates a new Raystack project with the recommended structure.
13
13
14
14
```
15
-
cotlette startproject myproject
15
+
raystack startproject myproject
16
16
```
17
17
18
18
### `startapp <app_name>`
19
19
Creates a new app inside your project.
20
20
21
21
```
22
-
cotlette startapp blog
22
+
raystack startapp blog
23
23
```
24
24
25
25
### `runserver`
26
26
Starts the development server (default: http://127.0.0.1:8000).
27
27
28
28
```
29
-
cotlette runserver
29
+
raystack runserver
30
30
```
31
31
32
32
### `shell`
33
33
Launches an interactive Python shell with project context loaded.
Copy file name to clipboardExpand all lines: .docs/extending.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Extending Cotlette
1
+
# Extending Raystack
2
2
3
3
## Overview
4
4
5
-
Cotlette is designed to be extensible. You can add your own apps, commands, middleware, and even swap out core components. This guide covers the main extension points.
5
+
Raystack is designed to be extensible. You can add your own apps, commands, middleware, and even swap out core components. This guide covers the main extension points.
6
6
7
7
---
8
8
@@ -35,7 +35,7 @@ INSTALLED_APPS = [
35
35
Add Python modules to `core/management/commands/`:
Copy file name to clipboardExpand all lines: .docs/faq.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
-
# Cotlette FAQ
1
+
# Raystack FAQ
2
2
3
3
## General
4
4
5
-
**Q: What is Cotlette?**
6
-
A: Cotlette is a modern web framework inspired by Django and built on top of FastAPI. It provides a familiar project structure, its own ORM, template rendering, and management commands.
5
+
**Q: What is Raystack?**
6
+
A: Raystack is a modern web framework inspired by Django and built on top of FastAPI. It provides a familiar project structure, its own ORM, template rendering, and management commands.
7
7
8
8
**Q: What Python versions are supported?**
9
9
A: Python 3.6 and higher.
@@ -15,31 +15,31 @@ A: SQLite is fully supported. PostgreSQL support is planned.
15
15
16
16
## Installation
17
17
18
-
**Q: How do I install Cotlette?**
19
-
A: Run `pip install cotlette`.
18
+
**Q: How do I install Raystack?**
19
+
A: Run `pip install raystack`.
20
20
21
21
**Q: How do I create a new project?**
22
-
A: Run `cotlette startproject myproject`.
22
+
A: Run `raystack startproject myproject`.
23
23
24
24
---
25
25
26
26
## Development
27
27
28
28
**Q: How do I run the development server?**
29
-
A: Run `cotlette runserver` in your project directory.
29
+
A: Run `raystack runserver` in your project directory.
30
30
31
31
**Q: How do I create a new app?**
32
-
A: Run `cotlette startapp myapp`.
32
+
A: Run `raystack startapp myapp`.
33
33
34
34
**Q: How do I use the shell?**
35
-
A: Run `cotlette shell` for an interactive Python shell with project context.
35
+
A: Run `raystack shell` for an interactive Python shell with project context.
36
36
37
37
---
38
38
39
39
## ORM
40
40
41
41
**Q: How do I define a model?**
42
-
A: Inherit from `cotlette.db.Model` and use field types from `cotlette.db.fields`.
42
+
A: Inherit from `raystack.db.Model` and use field types from `raystack.db.fields`.
43
43
44
44
**Q: How do I create tables?**
45
45
A: Call `Model.create_table()` for each model.
@@ -61,8 +61,8 @@ A: Use `render_template("template.html", context)` in your view.
61
61
62
62
## Troubleshooting
63
63
64
-
**Q: I get `ModuleNotFoundError: No module named 'cotlette'`**
65
-
A: Make sure your `PYTHONPATH` includes the `src/` directory, or install Cotlette in your environment.
64
+
**Q: I get `ModuleNotFoundError: No module named 'raystack'`**
65
+
A: Make sure your `PYTHONPATH` includes the `src/` directory, or install Raystack in your environment.
66
66
67
67
**Q: The server runs but I see a 404 page**
68
68
A: Make sure you have defined routes in your app and included them in your project URLs.
@@ -74,5 +74,5 @@ A: Ensure you have a `static/` directory and your settings are correct.
Copy file name to clipboardExpand all lines: .docs/index.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Cotlette Technical Documentation
1
+
# Raystack Technical Documentation
2
2
3
3
## Overview
4
4
5
-
Cotlette is a modern, Django-inspired web framework built on top of FastAPI. It provides a familiar project structure, its own ORM, template rendering, and a set of management commands for rapid web development. Cotlette is designed for both beginners and advanced users who want the power of FastAPI with the convenience of Django-like tools.
5
+
Raystack is a modern, Django-inspired web framework built on top of FastAPI. It provides a familiar project structure, its own ORM, template rendering, and a set of management commands for rapid web development. Raystack is designed for both beginners and advanced users who want the power of FastAPI with the convenience of Django-like tools.
6
6
7
7
---
8
8
@@ -15,14 +15,14 @@ Cotlette is a modern, Django-inspired web framework built on top of FastAPI. It
15
15
-[Templates](#templates)
16
16
-[Middleware](#middleware)
17
17
-[Management Commands](#management-commands)
18
-
-[Extending Cotlette](#extending-cotlette)
18
+
-[Extending Raystack](#extending-raystack)
19
19
-[FAQ](#faq)
20
20
21
21
---
22
22
23
23
## Project Structure
24
24
25
-
A typical Cotlette project looks like this:
25
+
A typical Raystack project looks like this:
26
26
27
27
```
28
28
myproject/
@@ -51,9 +51,9 @@ myproject/
51
51
52
52
## Architecture
53
53
54
-
Cotlette is built on FastAPI and leverages its async capabilities. Key components:
54
+
Raystack is built on FastAPI and leverages its async capabilities. Key components:
55
55
56
-
-**ASGI app**: FastAPI-based, with Cotlette-specific extensions
56
+
-**ASGI app**: FastAPI-based, with Raystack-specific extensions
57
57
-**ORM**: Synchronous, inspired by Django ORM, supports SQLite (PostgreSQL in roadmap)
58
58
-**Template Engine**: Jinja2 integration
59
59
-**Management Commands**: CLI for project/app creation, server, shell, migrations (planned)
@@ -111,7 +111,7 @@ See [.docs/commands.md](./commands.md).
111
111
112
112
---
113
113
114
-
## Extending Cotlette
114
+
## Extending Raystack
115
115
116
116
-**Custom apps**: Add your own Django-style apps
117
117
-**Custom commands**: Add CLI commands
@@ -133,5 +133,5 @@ See [.docs/faq.md](./faq.md) for common questions and troubleshooting.
Copy file name to clipboardExpand all lines: .docs/middleware.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
-
# Cotlette Middleware
1
+
# Raystack Middleware
2
2
3
3
## Overview
4
4
5
-
Middleware in Cotlette allows you to process requests and responses globally, similar to Django or FastAPI middleware. You can use built-in middleware or write your own for cross-cutting concerns like authentication, logging, or CORS.
5
+
Middleware in Raystack allows you to process requests and responses globally, similar to Django or FastAPI middleware. You can use built-in middleware or write your own for cross-cutting concerns like authentication, logging, or CORS.
6
6
7
7
---
8
8
9
9
## Built-in Middleware
10
10
11
-
Cotlette includes (or plans to include):
11
+
Raystack includes (or plans to include):
12
12
- Authentication middleware
13
13
- Session middleware
14
14
- CSRF protection (planned)
@@ -22,12 +22,12 @@ A middleware is a callable that takes a request and a handler, and returns a res
@@ -64,4 +64,4 @@ Middleware are executed in the order they are added. The order matters for thing
64
64
65
65
## More
66
66
67
-
See [FastAPI Middleware](https://fastapi.tiangolo.com/tutorial/middleware/) for advanced patterns (Cotlette is compatible with FastAPI middleware API).
67
+
See [FastAPI Middleware](https://fastapi.tiangolo.com/tutorial/middleware/) for advanced patterns (Raystack is compatible with FastAPI middleware API).
Copy file name to clipboardExpand all lines: .docs/orm.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,17 @@
1
-
# Cotlette ORM Documentation
1
+
# Raystack ORM Documentation
2
2
3
3
## Overview
4
4
5
-
Cotlette includes a lightweight, Django-inspired ORM for working with relational databases (currently SQLite, PostgreSQL in roadmap). It provides a familiar API for defining models, querying data, and managing relationships.
5
+
Raystack includes a lightweight, Django-inspired ORM for working with relational databases (currently SQLite, PostgreSQL in roadmap). It provides a familiar API for defining models, querying data, and managing relationships.
6
6
7
7
---
8
8
9
9
## Defining Models
10
10
11
-
Models are Python classes that inherit from `cotlette.db.Model` and use field types from `cotlette.db.fields`:
11
+
Models are Python classes that inherit from `raystack.db.Model` and use field types from `raystack.db.fields`:
0 commit comments