EC-21: FEAT: Added new pypi package and initialized the repo
Refers Evercatch/evercatch-board#21
This commit is contained in:
44
README.md
44
README.md
@@ -1,22 +1,32 @@
|
|||||||
# 📦 Repository Name
|
Of course. Here is the README template filled out to serve as a comprehensive placeholder for the upcoming SDK.
|
||||||
|
|
||||||
> Short one-line description of what this repository does.
|
It combines the professional structure of your new template with the "coming soon" message from your old one, setting clear expectations for anyone who discovers the repository.
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
# 📦 Evercatch Python
|
||||||
|
|
||||||
|
> Official Python SDK for Evercatch webhook infrastructure platform.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🧭 Overview
|
## 🧭 Overview
|
||||||
|
|
||||||
Describe what this service/module is responsible for within the Evercatch platform.
|
This repository contains the official Python SDK for the Evercatch platform. Its purpose is to provide a simple and convenient interface for developers to interact with the Evercatch API, manage webhooks, and handle events within their Python applications.
|
||||||
|
|
||||||
|
**⚠️ This SDK is currently under active development and is not yet ready for production use. The package published on PyPI is a placeholder to reserve the name.**
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🛠️ Tech Stack
|
## 🛠️ Tech Stack
|
||||||
|
|
||||||
|
The final technology stack is being determined. The planned stack is as follows:
|
||||||
|
|
||||||
| Layer | Technology |
|
| Layer | Technology |
|
||||||
| :--- | :--- |
|
| :--- | :--- |
|
||||||
| Language | — |
|
| Language | Python |
|
||||||
| Framework | — |
|
| Framework | None (Standard Library + Minimal Dependencies) |
|
||||||
| Key Dependencies | — |
|
| Key Dependencies | `httpx` or `requests` (for HTTP), `Pydantic` (for data models) |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -24,21 +34,27 @@ Describe what this service/module is responsible for within the Evercatch platfo
|
|||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- Docker & Docker Compose
|
- Python 3.12+
|
||||||
- Node.js / Python (specify version)
|
|
||||||
|
### Installation (Future)
|
||||||
|
|
||||||
|
Once released, the package will be available on PyPI:
|
||||||
|
```bash
|
||||||
|
# This will not work until the first official release
|
||||||
|
pip install evercatch
|
||||||
|
```
|
||||||
|
|
||||||
### Local Development
|
### Local Development
|
||||||
|
|
||||||
|
The repository can be cloned for contribution or testing once development is further along.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clone the repo
|
# Clone the repo
|
||||||
git clone https://git.psmattas.com/Evercatch/REPO_NAME.git
|
git clone https://git.psmattas.com/Evercatch/evercatch-python.git
|
||||||
cd REPO_NAME
|
|
||||||
|
|
||||||
# Copy environment variables
|
cd evercatch-python
|
||||||
cp .env.example .env
|
|
||||||
|
|
||||||
# Start services
|
# Note: The project is not yet functional.
|
||||||
docker compose up -d
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
0
evercatch/__init__.py
Normal file
0
evercatch/__init__.py
Normal file
7
poetry.lock
generated
Normal file
7
poetry.lock
generated
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand.
|
||||||
|
package = []
|
||||||
|
|
||||||
|
[metadata]
|
||||||
|
lock-version = "2.0"
|
||||||
|
python-versions = "^3.12"
|
||||||
|
content-hash = "34e39677d8527182346093002688d17a5d2fc204b9eb3e094b2e6ac519028228"
|
||||||
28
pyproject.toml
Normal file
28
pyproject.toml
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ["poetry-core"]
|
||||||
|
build-backend = "poetry.core.masonry.api"
|
||||||
|
|
||||||
|
[tool.poetry]
|
||||||
|
name = "evercatch"
|
||||||
|
version = "0.0.1"
|
||||||
|
description = "Official Python SDK for Evercatch webhook infrastructure platform."
|
||||||
|
authors = ["Evercatch <support@evercatch.dev>"]
|
||||||
|
license = "MIT"
|
||||||
|
readme = "README.md"
|
||||||
|
repository = "https://git.psmattas.com/evercatch/evercatch-python"
|
||||||
|
keywords = ["evercatch", "sdk", "api", "webhooks"]
|
||||||
|
|
||||||
|
# These classifiers are important for PyPI to categorize your package correctly
|
||||||
|
classifiers = [
|
||||||
|
"Development Status :: 1 - Planning",
|
||||||
|
"Intended Audience :: Developers",
|
||||||
|
"License :: OSI Approved :: MIT License",
|
||||||
|
"Programming Language :: Python :: 3",
|
||||||
|
"Programming Language :: Python :: 3.12",
|
||||||
|
]
|
||||||
|
|
||||||
|
# This tells Poetry that your package code is in the 'evercatch' folder
|
||||||
|
packages = [{ include = "evercatch" }]
|
||||||
|
|
||||||
|
[tool.poetry.dependencies]
|
||||||
|
python = "^3.12"
|
||||||
Reference in New Issue
Block a user