Skip to content

Commit bcf1534

Browse files
eadwinCodeeadwinCode
committed
fixing docs
1 parent 658b08c commit bcf1534

File tree

2 files changed

+113
-16
lines changed

2 files changed

+113
-16
lines changed

‎README.md‎

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,42 @@ It is built on top of Starlette, a renowned ASGI toolkit, ensuring robust asynch
3131
- **Guards for Authentication and Authorization**: Offers built-in support for guards, making it easy to implement authentication and authorization in applications.
3232
- **Modularity**: Inspired by NestJS, Ellar follows a modular architecture, allowing developers to organize code into reusable modules.
3333
- **Asynchronous Programming**: Leveraging Python's async/await feature, Ellar enables the development of efficient and high-performance applications capable of handling concurrent requests.
34+
- **Type Hints Support**: Built with modern Python type hints for better IDE support and code reliability.
35+
- **WebSocket Support**: Native WebSocket support for real-time bidirectional communication.
36+
- **Database Agnostic**: Freedom to use any database with built-in support for popular ORMs.
37+
- **Testing Utilities**: Comprehensive testing utilities for unit and integration testing.
3438

3539
## **Installation**
3640

3741
You can install Ellar using pip:
3842

3943
```bash
40-
$(venv) pip install ellar
44+
# Create and activate virtual environment (recommended)
45+
python -m venv venv
46+
source venv/bin/activate # On Windows use: venv\Scripts\activate
47+
48+
# Install Ellar
49+
pip install ellar
50+
```
51+
52+
## **Quick Start**
53+
54+
```python
55+
# main.py
56+
from ellar.common import get, Controller, ControllerBase
57+
from ellar.app import AppFactory
58+
59+
@Controller()
60+
class HomeController(ControllerBase):
61+
@get('/')
62+
async def index(self):
63+
return {'message': 'Welcome to Ellar Framework!'}
64+
65+
app = AppFactory.create_app(controllers=[HomeController])
66+
67+
# Run the application
68+
if __name__ == "__main__":
69+
uvicorn.run("main:app", port=5000, reload=True)
4170
```
4271

4372
## **Getting Started**
@@ -132,15 +161,23 @@ You can also try the [quick-project](https://python-ellar.github.io/ellar/quick-
132161

133162
## **Project Documentation Status**
134163
- Authorization: In progress
164+
- Complete documentation available at: https://python-ellar.github.io/ellar/
165+
- API Reference: https://python-ellar.github.io/ellar/references/
135166

136167
## **Dependency Summary**
137168

138-
Ellar has the following dependencies:
169+
Ellar has the following core dependencies:
139170

140171
- Python >= 3.8
141-
- Starlette
142-
- Pydantic
143-
- Injector
172+
- Starlette >= 0.27.0
173+
- Pydantic >= 2.0
174+
- Injector >= 0.19.0
175+
- typing-extensions >= 4.5.0
176+
177+
Optional dependencies:
178+
- jinja2 - For template rendering
179+
- python-multipart - For form data parsing
180+
- itsdangerous - For security features
144181

145182
## **Contributing**
146183
Contributions are Welcome! You can contribute in the following ways.

‎docs/index.md‎

Lines changed: 71 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
# **Ellar - ASGI Python Framework**
22
<p align="center">
3-
<a href="#" target="blank"><img src="img/EllarLogoB.png" width="200" alt="Ellar Logo" /></a>
3+
<a href="#" target="blank"><img src="https://python-ellar.github.io/ellar/img/EllarLogoB.png" width="200" alt="Ellar Logo" /></a>
44
</p>
5+
<p align="end">logo by: <a target="_blank" href="https://www.behance.net/azadvertised">Azad</a></p>
56

6-
<p align="center"> Ellar - Python ASGI web framework for building fast, efficient, and scalable RESTAPIs and server-side applications. </p>
7+
<p align="center"> Ellar - Python ASGI web framework for building fast, efficient, and scalable RESTful APIs and server-side applications. </p>
78

89
![Test](https://github.com/python-ellar/ellar/actions/workflows/test_full.yml/badge.svg)
910
![Coverage](https://img.shields.io/codecov/c/github/python-ellar/ellar)
1011
[![PyPI version](https://badge.fury.io/py/ellar.svg)](https://badge.fury.io/py/ellar)
1112
[![PyPI version](https://img.shields.io/pypi/v/ellar.svg)](https://pypi.python.org/pypi/ellar)
1213
[![PyPI version](https://img.shields.io/pypi/pyversions/ellar.svg)](https://pypi.python.org/pypi/ellar)
1314

14-
---
15-
1615
## **Introduction**
1716

1817
Ellar is a lightweight ASGI framework designed to simplify the development of efficient and scalable server-side Python
@@ -33,13 +32,42 @@ It is built on top of Starlette, a renowned ASGI toolkit, ensuring robust asynch
3332
- **Guards for Authentication and Authorization**: Offers built-in support for guards, making it easy to implement authentication and authorization in applications.
3433
- **Modularity**: Inspired by NestJS, Ellar follows a modular architecture, allowing developers to organize code into reusable modules.
3534
- **Asynchronous Programming**: Leveraging Python's async/await feature, Ellar enables the development of efficient and high-performance applications capable of handling concurrent requests.
35+
- **Type Hints Support**: Built with modern Python type hints for better IDE support and code reliability.
36+
- **WebSocket Support**: Native WebSocket support for real-time bidirectional communication.
37+
- **Database Agnostic**: Freedom to use any database with built-in support for popular ORMs.
38+
- **Testing Utilities**: Comprehensive testing utilities for unit and integration testing.
3639

3740
## **Installation**
3841

3942
You can install Ellar using pip:
4043

4144
```bash
42-
$(venv) pip install ellar
45+
# Create and activate virtual environment (recommended)
46+
python -m venv venv
47+
source venv/bin/activate # On Windows use: venv\Scripts\activate
48+
49+
# Install Ellar
50+
pip install ellar
51+
```
52+
53+
## **Quick Start**
54+
55+
```python
56+
# main.py
57+
from ellar.common import get, Controller, ControllerBase
58+
from ellar.app import AppFactory
59+
60+
@Controller()
61+
class HomeController(ControllerBase):
62+
@get('/')
63+
async def index(self):
64+
return {'message': 'Welcome to Ellar Framework!'}
65+
66+
app = AppFactory.create_app(controllers=[HomeController])
67+
68+
# Run the application
69+
if __name__ == "__main__":
70+
uvicorn.run("main:app", port=5000, reload=True)
4371
```
4472

4573
## **Getting Started**
@@ -126,10 +154,46 @@ if __name__ == "__main__":
126154
uvicorn.run("main:app", port=5000, reload=True)
127155
```
128156

157+
You can access the Ellar API documentation at [http://127.0.0.1:5000/docs](http://127.0.0.1:5000/docs#/). Additionally, you can try the [quick-project setup](quick-project.md) to get started quickly with Ellar.
129158

130-
Now we can test our API at [http://127.0.0.1:5000/docs](http://127.0.0.1:5000/docs#/)
131159

132-
You can also try the [quick-project](https://python-ellar.github.io/ellar/quick-project/) setup to get a good idea of the library.
160+
## **Project Documentation Status**
161+
- Authorization: In progress
162+
- Complete documentation available at: https://python-ellar.github.io/ellar/
163+
- API Reference: https://python-ellar.github.io/ellar/references/
164+
165+
## **Dependency Summary**
166+
167+
Ellar has the following core dependencies:
168+
169+
- Python >= 3.8
170+
- Starlette >= 0.27.0
171+
- Pydantic >= 2.0
172+
- Injector >= 0.19.0
173+
- typing-extensions >= 4.5.0
174+
175+
Optional dependencies:
176+
- jinja2 - For template rendering
177+
- python-multipart - For form data parsing
178+
- itsdangerous - For security features
179+
180+
## **Contributing**
181+
Contributions are Welcome! You can contribute in the following ways.
182+
183+
- **Create an Issue** - Propose a new feature. Report a bug.
184+
- **Pull Request** - Fix a bug and typo. Refactor the code.
185+
- **Create third-party module** - Just like ellar-throttling, ellar-jwt, ellar-sql that can solve common problem in web application development.
186+
- **Share** - Share your thoughts on the a Blog, Twitter, and others.
187+
- **Build your application** - Please try to use Ellar. For more details, see [docs/CONTRIBUTING.md](https://github.com/python-ellar/ellar/blob/main/docs/contribution.md).
188+
189+
## **Contributors**
190+
Thanks to all contributors!
191+
192+
## **Author**
193+
Ezeudoh Tochukwu https://github.com/eadwinCode
194+
195+
## **License**
196+
Ellar is [MIT License](https://github.com/python-ellar/ellar/blob/main/LICENSE).
133197

134198

135199
## **Project Documentation Status**
@@ -143,7 +207,3 @@ Ellar has the following dependencies:
143207
- Starlette
144208
- Pydantic
145209
- Injector
146-
147-
## **Try It Out**
148-
149-
You can access the Ellar API documentation at [http://127.0.0.1:5000/docs](http://127.0.0.1:5000/docs#/). Additionally, you can try the [quick-project setup](quick-project.md) to get started quickly with Ellar.

0 commit comments

Comments
 (0)