readme update
This commit is contained in:
114
README.md
114
README.md
@@ -0,0 +1,114 @@
|
|||||||
|
# Excel-project
|
||||||
|
|
||||||
|
Проект для обработки, валидации и агрегации Excel-отчётов от маркетплейсов
|
||||||
|
(**Ozon, Wildberries, Яндекс Маркет**) с целью формирования унифицированных данных и заноса их в 1С
|
||||||
|
(реализация, выкупы, товары на комиссии).
|
||||||
|
|
||||||
|
Проект представляет собой Python-приложение с backend-логикой, API и обработчиками Excel-файлов.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📌 Возможности
|
||||||
|
|
||||||
|
- 📊 Обработка Excel-отчётов маркетплейсов:
|
||||||
|
- Ozon
|
||||||
|
- Wildberries
|
||||||
|
- Яндекс Маркет
|
||||||
|
- 🧾 Поддержка отчетов:
|
||||||
|
- реализация
|
||||||
|
- выкупы
|
||||||
|
- товары, переданные на комиссию
|
||||||
|
- ✅ Валидация входных файлов
|
||||||
|
- 🗂 Работа со справочниками (компании, контрагенты, номенклатура, склады)
|
||||||
|
- 🔌 API для работы с данными
|
||||||
|
- 📁 Примеры входных документов
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📁 Структура проекта
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── env_example #Пример заполнения env файла
|
||||||
|
├── excel_files #Вывод программы при запуске с флагами
|
||||||
|
│ ├── companies.xlsx
|
||||||
|
│ ├── contractors.xlsx
|
||||||
|
│ ├── documents.txt
|
||||||
|
│ ├── nomenclature.xlsx
|
||||||
|
│ └── storages.xlsx
|
||||||
|
├── makefile #Точка входа, запуск приложения и утилит
|
||||||
|
├── README.md
|
||||||
|
├── requirements.txt #Зависимости
|
||||||
|
├── run.py #Точка входа, запуск приложения
|
||||||
|
└── server
|
||||||
|
├── __init__.py
|
||||||
|
├── backend #Исходный код:API, pydantic, handlers, services
|
||||||
|
│ ├── __init__.py
|
||||||
|
│ ├── api #Запросы к серверу 1С
|
||||||
|
│ │ ├── __init__.py
|
||||||
|
│ │ ├── companies.py
|
||||||
|
│ │ ├── contractors.py
|
||||||
|
│ │ ├── nomenclature.py
|
||||||
|
│ │ ├── report.py
|
||||||
|
│ │ ├── session.py
|
||||||
|
│ │ └── storages.py
|
||||||
|
│ ├── handlers #Обработка Excel
|
||||||
|
│ │ ├── __init__.py
|
||||||
|
│ │ ├── ozon_handler.py
|
||||||
|
│ │ ├── ozon_purchases_handler.py
|
||||||
|
│ │ ├── ozon_wb_yandex_com_handler.py
|
||||||
|
│ │ ├── wb_handler.py
|
||||||
|
│ │ ├── wb_purchases_handler.py
|
||||||
|
│ │ └── yandex_handler.py
|
||||||
|
│ ├── schemas #Валидация
|
||||||
|
│ │ ├── __init__.py
|
||||||
|
│ │ └── pydantic.py
|
||||||
|
│ └── services #Поиск и открытие файлов
|
||||||
|
│ ├── __init__.py
|
||||||
|
│ ├── excel.py
|
||||||
|
│ └── validating_files.py
|
||||||
|
└── frontend #Пусто типо
|
||||||
|
└── __init__.py
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## ⚙️ Требования
|
||||||
|
|
||||||
|
- Python 3.13.3
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚀 Установка и запуск
|
||||||
|
|
||||||
|
1. Клонировать репозиторий:
|
||||||
|
```bash
|
||||||
|
git clone <URL репозитория>
|
||||||
|
cd excel
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Создать и активировать виртуальное окружение:
|
||||||
|
```
|
||||||
|
python3 -m venv .venv
|
||||||
|
source .venv/bin/activate # Linux / macOS
|
||||||
|
venv\Scripts\activate # Windows
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Установить зависимости:
|
||||||
|
```
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Настроить .env файл (по примеру env_example):
|
||||||
|
|
||||||
|
5. Настроить колонки excel в файлах *_handler.py
|
||||||
|
|
||||||
|
6. Запустить приложение:
|
||||||
|
```
|
||||||
|
python run.py или вне окружения сразу прописать make run
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
📜 Лицензия
|
||||||
|
|
||||||
|
Учебный проект.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user