From 6e78a0065f6d66d6246b867d41e95ed48be4deea Mon Sep 17 00:00:00 2001 From: Aarav-g123 <138991532+Aarav-g123@users.noreply.github.com> Date: Thu, 17 Aug 2023 18:32:18 +0100 Subject: [PATCH] Changed the Readme.md to include the article and added Contributors.txt --- CONTRIBUTORS.txt | 3 +- README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 73 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 4c2aadc9..59226345 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -21,4 +21,5 @@ Vladyslav Ovchynnykov Toufeeq Ockards Rafael Cascalho Everone Graham -Batul Salhab \ No newline at end of file +Batul Salhab +Aarav Gupta \ No newline at end of file diff --git a/README.md b/README.md index f323adc9..8e8deed3 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,77 @@ Then, navigate in your browser to `http://localhost:8080/` `--uvloop` - uvloop event loop for aiohttp + + # Articles +--- + +## Simplify Your aiohttp Application Development with Create aio app + +Are you looking to kickstart your aiohttp application development while following best practices? Look no further than `create-aio-app`! This powerful tool is designed to help you bootstrap aiohttp applications with ease, setting you up for efficient and structured development right from the start. + +**Streamlined Setup Process** + +`create-aio-app` simplifies the process of creating a new aiohttp project. With just a single command, you can generate a project structure that adheres to best practices and includes all the necessary components to get you started. + +**Interactive Mode for Flexibility** + +If you prefer a more interactive approach, `create-aio-app` has got you covered. Enter the command without any arguments, and the tool will guide you through the setup process step by step, allowing you to configure various options along the way. + +**A Screenshot Worth a Thousand Words** + +To give you a sneak peek into what you can expect, `create-aio-app` provides an interface screenshot that showcases the structure and components of the generated project. This visual representation helps you understand the initial setup at a glance. + +**Feature-Rich Development Stack** + +`create-aio-app` comes packed with a plethora of features that make it an ideal choice for your aiohttp projects: + +- **aiohttp Framework**: The foundation of your application, aiohttp is a robust and high-performance Python web framework that allows you to build asynchronous web applications effortlessly. + +- **Optional Static Typing with mypy**: Ensure code correctness and improve maintainability by incorporating optional static typing using the popular `mypy` tool. + +- **Unit Testing with pytest**: Create comprehensive unit tests using `pytest` to verify the functionality of your code and catch any issues early in the development process. + +- **Code Formatting with black**: Maintain consistent and readable code using `black`, a code formatter that automatically formats your code according to Python's style guide. + +- **Linter Support with flake8**: Detect and fix code style and syntax errors using `flake8`, a powerful linter for Python code. + +- **Data Validation with trafaret**: Implement data validation effortlessly with `trafaret`, ensuring that your application processes data accurately. + +- **Developer Tools and Debugging**: Leverage `aio devtools` and `aiohttp debug toolbar` to enhance your debugging experience and streamline development. + +- **Database Integration**: `create-aio-app` supports `postgres` for data storage, along with `alembic` for database migrations and `sqlAlchemy` for object-relational mapping. + +- **Documentation with sphinx**: Generate comprehensive documentation for your project using `sphinx`, making it easier for developers to understand and contribute to your codebase. + +- **Docker Support with docker-compose**: Define and manage multi-container Docker applications seamlessly using `docker-compose`. + +- **Profiling with py-spy**: Identify performance bottlenecks and optimize your application using the `py-spy` sampling profiler. + +**Customization Options** + +`create-aio-app` also provides customization options to suit your project's specific requirements: + +- `--without-postgres`: Remove postgres and its requirements if not needed for your project. + +- `--redis`: Add redis to the template for integrating a Redis database. + +- `--uvloop`: Opt for the `uvloop` event loop for aiohttp, enhancing the performance of your asynchronous application. + +**Community-Driven and Open Source** + +`create-aio-app` is a collaborative effort from the aiohttp community for the aiohttp community. Feel free to contribute by suggesting improvements or creating pull requests. The community welcomes your input and is committed to making the tool even more powerful and user-friendly. + + +**In Conclusion** + +With `create-aio-app`, you can accelerate your aiohttp application development by starting off with a well-structured, feature-rich project template. Whether you're a seasoned developer or just starting your Python journey, this tool provides the foundation you need to build efficient and robust web applications. Give it a try and experience the benefits firsthand! + +For more information and detailed commands, check out the official [documentation](https://create-aio-app.readthedocs.io/pages/commands.html). + +--- + + + ## Contributing `create-aio-app` is a boilerplate from aiohttp community for aiohttp