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: README.md
+82-6Lines changed: 82 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,9 @@
2
2
3
3
**Architecture + Python – Perfect for Structured Design**
4
4
5
-
ArchiPy is a Python project designed to provide a robust and structured architecture for building scalable and maintainable applications. It integrates modern Python tools and libraries to streamline development, testing, and deployment.
5
+
ArchiPy is a Python project designed to provide a robust and structured architecture for building scalable and
6
+
maintainable applications. It integrates modern Python tools and libraries to streamline development, testing, and
7
+
deployment.
6
8
7
9
---
8
10
@@ -21,7 +23,8 @@ ArchiPy is a Python project designed to provide a robust and structured architec
21
23
22
24
## ✨ Features
23
25
24
-
-**Modern Python Stack**: Built with Python 3.13 and leveraging tools like `pydantic`, `fastapi`, `gRPC` and `sqlalchemy`.
26
+
-**Modern Python Stack**: Built with Python 3.13 and leveraging tools like `pydantic`, `fastapi`, `gRPC` and
27
+
`sqlalchemy`.
25
28
-**Modular Design**: Optional dependencies for Redis, gRPC, PostgreSQL, Prometheus, and more.
26
29
-**Type Safety**: Enforced by `mypy` and `pydantic` for robust code.
27
30
-**Testing**: Integrated with `pytest` and `behave` for comprehensive testing.
@@ -35,11 +38,20 @@ ArchiPy is a Python project designed to provide a robust and structured architec
35
38
36
39
Before you begin, ensure you have the following installed:
37
40
38
-
-**Python 3.13.x**
41
+
-**Python 3.13 or higher**
42
+
`archipy` is compatible with Python 3.13 and above but does not support Python 4 or higher.
43
+
To check your Python version, run:
44
+
```bash
45
+
python --version
46
+
```
47
+
If your Python version is lower than 3.13, [download and install the latest version of Python](https://www.python.org/downloads/).
48
+
39
49
-**Poetry** (for dependency management)
50
+
Poetry is required to manage dependencies and install the project. If you don’t have Poetry installed, follow the [official installation guide](https://python-poetry.org/docs/).
40
51
41
52
---
42
53
54
+
43
55
## 🚀 Installation
44
56
45
57
1.**Clone the Repository**
@@ -67,14 +79,78 @@ Before you begin, ensure you have the following installed:
67
79
68
80
## 🎯 Usage
69
81
70
-
### Running the Project
71
82
72
-
To run the project locally, use the following command:
83
+
### Installing the Project
84
+
85
+
You can install the project and its dependencies using either `pip` or `poetry`. Below are the instructions for both.
86
+
87
+
#### Using `pip`
88
+
89
+
To install the core library:
90
+
91
+
```bash
92
+
pip install archipy
93
+
```
94
+
95
+
To install the library with optional dependencies (e.g., `redis`, `fastapi`, etc.):
96
+
97
+
```bash
98
+
pip install archipy[redis,fastapi]
99
+
```
100
+
101
+
#### Using `poetry`
102
+
103
+
To add the core library to your project:
104
+
105
+
```bash
106
+
poetry add archipy
107
+
```
108
+
109
+
To add the library with optional dependencies (e.g., `redis`, `fastapi`, etc.):
73
110
74
111
```bash
75
-
poetry run python -m archipy
112
+
poetry add archipy[redis,fastapi]
76
113
```
77
114
115
+
---
116
+
117
+
### Optional Dependencies
118
+
119
+
The library provides optional dependencies for additional functionality. You can install them as needed:
0 commit comments