Metadata-Version: 2.4
Name: apex-restpy
Version: 0.1.0
Summary: A Python library for connecting to Oracle APEX RESTful APIs — Python adaptation of ApexBridge.
Author-email: Ata Can Yaymacı <atacanymc@gmail.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1.1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the LICENSE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
Project-URL: Homepage, https://github.com/AtaCanYmc/ApexRestpy
Project-URL: Repository, https://github.com/AtaCanYmc/ApexRestpy
Project-URL: Bug Tracker, https://github.com/AtaCanYmc/ApexRestpy/issues
Project-URL: C++ Original, https://github.com/AtaCanYmc/ApexBridge
Keywords: oracle,apex,rest,api,http,iot
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.28.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: ruff>=0.4.0; extra == "dev"
Requires-Dist: mypy>=1.8.0; extra == "dev"
Requires-Dist: types-requests>=2.28.0; extra == "dev"
Dynamic: license-file

<div align="center">

# 🌉 ApexRestpy

### Oracle APEX RESTful API Client — Python

*A Python Adaptation of the [ApexBridge C++ Arduino Library](https://github.com/AtaCanYmc/ApexBridge)*

---

[![CI](https://github.com/AtaCanYmc/ApexRestpy/actions/workflows/ci.yml/badge.svg)](https://github.com/AtaCanYmc/ApexRestpy/actions/workflows/ci.yml)
[![Release](https://github.com/AtaCanYmc/ApexRestpy/actions/workflows/release-please.yml/badge.svg)](https://github.com/AtaCanYmc/ApexRestpy/actions/workflows/release-please.yml)
[![PyPI version](https://img.shields.io/pypi/v/apex-restpy.svg?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/apex-restpy/)
[![Python Versions](https://img.shields.io/pypi/pyversions/apex-restpy.svg?logo=python&logoColor=white)](https://pypi.org/project/apex-restpy/)
[![codecov](https://codecov.io/gh/AtaCanYmc/ApexRestpy/branch/main/graph/badge.svg)](https://codecov.io/gh/AtaCanYmc/ApexRestpy)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
[![License: ApacheV2](https://img.shields.io/badge/License-Apache-yellow.svg)](https://opensource.org/licenses/MIT)
[![Downloads](https://img.shields.io/pypi/dm/apex-restpy.svg?color=green)](https://pypi.org/project/apex-restpy/)

</div>

---

## 📋 Table of Contents

- [Executive Summary](#-executive-summary)
- [Key Features](#-key-features)
- [Architecture & Flow](#%EF%B8%8F-architecture--flow)
- [Tech Stack](#%EF%B8%8F-tech-stack)
- [Prerequisites](#-prerequisites)
- [Installation](#-installation)
- [Quick Start](#-quick-start)
- [Usage & API Reference](#-usage--api-reference)
- [Environment Variables](#-environment-variables)
- [Testing](#-testing)
- [Contributing](#-contributing)
- [Security Policy](#-security-policy)
- [License & Contact](#-license--contact)

---

## 🎯 Executive Summary

**ApexRestpy** is a lightweight, minimal-dependency (only `requests`) client library that enables Python applications to communicate swiftly with Oracle APEX RESTful services. It is a direct Python adaptation of the [ApexBridge](https://github.com/AtaCanYmc/ApexBridge) library written in C++ for microcontrollers (ESP32/ESP8266); you can use the same logical API on servers, Raspberry Pi, automation scripts, and CI/CD pipelines.

The library abstracts Oracle APEX's standard `/<base_path>/<schema>/<module>/<resource>` URL structure and provides Bearer token authentication, query parameter management, and all HTTP methods (GET/POST/PUT/PATCH/DELETE) through a unified, easy-to-test interface. HTTPS connections are established with zero configuration; SSL certificate management is handled entirely and automatically by `requests + certifi`.

**Target audience:** Python developers using Oracle APEX as a backend, IoT integration engineers, and embedded systems developers migrating from the Arduino ecosystem to Python.

---

## ✨ Key Features

| Feature | Description |
|---|---|
| 🔗 **Seamless APEX Communication** | Automatic endpoint construction with the `schema/module/resource` URL pattern |
| 🔒 **Automatic HTTPS** | Zero-configuration SSL via `requests + certifi` — no manual certificates |
| 🔑 **Bearer Token Authentication** | One-line OAuth/JWT integration with `set_token()` |
| 🛠️ **Full HTTP Support** | GET · POST · PUT · PATCH · DELETE |
| 🧩 **Fluent URL Management** | Chainable API: `prepare_url()` + `add_parameter()` + `add_path()` |
| 🐍 **Pythonic Design** | `snake_case`, `@dataclass`, type hints, `logging` module |
| ⚡ **Lightweight** | Single external dependency: `requests>=2.28` |
| 🧪 **High Test Coverage** | 38 unit tests, mocked HTTP — no real network required |
| 🔄 **Session Management** | Connection reuse via `requests.Session` |
| 📦 **Installable** | Standard PyPI installation with `pip install apex-restpy` |

---

## 🏗️ Architecture & Flow

ApexRestpy acts as a thin abstraction layer between your application and the Oracle APEX server:

```mermaid
flowchart LR
    subgraph Application["Your Application"]
        direction TB
        A["bridge = ApexBridge(schema)"]
        B["bridge.set_token(token)"]
        C["bridge.prepare_url(module, resource)"]
        D["bridge.add_parameter(k, v)"]
        E["bridge.send_request('GET')"]
    end

    subgraph ApexRestpy["apex_restpy Layer"]
        direction TB
        AB["ApexBridge"]
        APP["ApexApp @dataclass"]
        EXC["ApexConnectionError\nApexResponseError"]
        AB --> APP
        AB --> EXC
    end

    subgraph HTTP["HTTP Layer"]
        REQ["requests.Session\n(HTTPS + certifi)"]
    end

    subgraph APEX["Oracle APEX"]
        ORDS["APEX REST Services\nhttps://apex.oracle.com/pls/apex/\n{schema}/{module}/{resource}"]
    end

    Application --> ApexRestpy
    ApexRestpy --> HTTP
    HTTP -->|"HTTPS GET/POST/PUT/PATCH/DELETE"| APEX
    APEX -->|"JSON Response"| HTTP
    HTTP -->|"dict"| ApexRestpy
    ApexRestpy -->|"dict"| Application
```

### URL Construction Process

```
ApexApp.base_path  +  schema   +  module  +  resource  [?param=val&...]  [/path]
    /pls/apex      /  myschema /  sensor  /   data     ?id=42&type=temp  /details

→ https://apex.oracle.com/pls/apex/myschema/sensor/data/details?id=42&type=temp
```

### Package Structure

```
apex_restpy/
├── __init__.py          # Public API: ApexBridge, ApexApp, exceptions
├── apex_bridge.py       # Core client class
├── apex_app.py          # Configuration dataclass
└── exceptions.py        # ApexConnectionError, ApexResponseError

tests/
└── test_apex_bridge.py  # 38 unit tests (mocked HTTP)

examples/
├── basic_get.py         # GET example
└── basic_post.py        # POST example
```

---

## 🛠️ Tech Stack

| Layer | Technology | Version |
|---|---|---|
| **Language** | Python | ≥ 3.9 |
| **HTTP Client** | requests | ≥ 2.28.0 |
| **SSL** | certifi (requests dependency) | Automatic |
| **Packaging** | setuptools + pyproject.toml | PEP 517/518 |
| **Lint** | Ruff | ≥ 0.4.0 |
| **Type Checking** | mypy | ≥ 1.8.0 |
| **Testing** | pytest + pytest-cov | ≥ 7.0 / ≥ 4.0 |
| **CI/CD** | GitHub Actions | — |
| **Release Management** | Release Please | v4 |
| **Dependency Updates** | Dependabot | — |

---

## ✅ Prerequisites

The following tools must be installed in your development environment:

| Tool | Minimum Version | Check |
|---|---|---|
| Python | 3.9 | `python --version` |
| pip | 21.0 | `pip --version` |
| Git | 2.30 | `git --version` |

> [!NOTE]
> As a library, the only runtime dependency is `requests`. No Docker or other infrastructure tooling is required.

---

## 🚀 Installation

### From PyPI (Recommended)

```bash
pip install apex-restpy
```

### Development Setup

```bash
# 1. Clone the repository
git clone https://github.com/AtaCanYmc/ApexRestpy.git
cd ApexRestpy

# 2. Create and activate a virtual environment
python -m venv .venv
source .venv/bin/activate        # Linux / macOS
# .venv\Scripts\activate.bat     # Windows CMD
# .venv\Scripts\Activate.ps1     # Windows PowerShell

# 3. Install the package with development dependencies
pip install -e ".[dev]"
```

### Verify Installation

```bash
python -c "from apex_restpy import ApexBridge; print('✅ apex-restpy is ready!')"
```

---

## ⚡ Quick Start

```python
from apex_restpy import ApexBridge

# 1. Initialise the bridge
bridge = ApexBridge(schema="myschema")

# 2. (Optional) Set the authentication token
bridge.set_token("your-jwt-bearer-token")

# 3. Prepare the endpoint and send a request
bridge.prepare_url("time", "now")
response = bridge.send_request()   # default: GET

# 4. Use the response
print(response["full_timestamp"])  # → "2025-03-02T14:30:00"
print(response["year"])            # → 2025
```

---

## 📖 Usage & API Reference

### `ApexBridge(schema, base_path, host, timeout, debug, session)`

The core client class. All APEX communication is handled through this object.

```python
bridge = ApexBridge(
    schema="myschema",          # APEX workspace schema name (required)
    base_path="/pls/apex",      # URL prefix (default: "/pls/apex")
    host="apex.oracle.com",     # APEX server address (default)
    timeout=10.0,               # Request timeout in seconds (default: 10)
    debug=False,                # If True, enables DEBUG log level
)
```

---

### `set_token(token: str)`

Enables Bearer token authentication. The `Authorization: Bearer <token>` header is automatically added to all subsequent requests.

```python
bridge.set_token("eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...")
```

> [!NOTE]
> The token must be longer than 1 character (exact compatibility with the C++ original). If an empty string is provided, the header is not added.

---

### `prepare_url(module, resource, schema=None) → str`

Constructs the APEX REST endpoint path and stores it in the internal `_last_endpoint`.

```python
url = bridge.prepare_url("sensor", "data")
# → "/pls/apex/myschema/sensor/data"

# With a different schema
url = bridge.prepare_url("time", "now", schema="otherschema")
# → "/pls/apex/otherschema/time/now"
```

---

### `add_parameter(param, value, url=None) → str`

Appends a query parameter to the active endpoint (or a given URL).

```python
bridge.prepare_url("sensor", "data")
bridge.add_parameter("id", "42")       # → ...?id=42
bridge.add_parameter("type", "temp")   # → ...?id=42&type=temp

# On a custom URL (the stored endpoint is not modified)
result = bridge.add_parameter("limit", "10", url="/pls/apex/myschema/items/list")
# → "/pls/apex/myschema/items/list?limit=10"
```

---

### `add_path(path, url=None) → str`

Appends an additional path segment to the active endpoint.

```python
bridge.prepare_url("items", "list")
bridge.add_path("active")
# _last_endpoint → "/pls/apex/myschema/items/list/active"
```

---

### `send_request(method="GET", payload=None, url=None) → dict`

Sends an HTTP request and returns the JSON response as a `dict`.

```python
# GET
response = bridge.send_request()

# POST — with a JSON body
response = bridge.send_request(
    method="POST",
    payload={"sensor_id": "42", "value": 23.5},
)

# PUT, PATCH, DELETE
bridge.send_request("PUT",   payload={"name": "updated"})
bridge.send_request("PATCH", payload={"status": "active"})
bridge.send_request("DELETE")

# Request to a different URL (the stored endpoint is not modified)
response = bridge.send_request("GET", url="/pls/apex/myschema/custom/path")
```

**Supported methods:** `GET` · `POST` · `PUT` · `PATCH` · `DELETE`

---

### Exceptions

| Exception | When raised |
|---|---|
| `ApexConnectionError` | Network connection cannot be established or times out |
| `ApexResponseError` | Response body is not valid JSON |
| `ValueError` | An unsupported HTTP method is provided |

```python
from apex_restpy import ApexBridge, ApexConnectionError, ApexResponseError

try:
    response = bridge.send_request()
except ApexConnectionError as e:
    print(f"Connection error: {e}")
except ApexResponseError as e:
    print(f"Invalid response: {e}")
```

---

### Full Scenario Example

```python
from apex_restpy import ApexBridge

bridge = ApexBridge(schema="iot_prod", timeout=15.0, debug=True)
bridge.set_token("your-jwt-token")

# Fetching data with pagination and filtering
bridge.prepare_url("sensors", "readings")
bridge.add_parameter("device_id", "esp32-01")
bridge.add_parameter("limit", "100")
bridge.add_path("latest")
# → /pls/apex/iot_prod/sensors/readings/latest?device_id=esp32-01&limit=100

response = bridge.send_request("GET")

for reading in response.get("items", []):
    print(f"{reading['ts']} → {reading['value']} {reading['unit']}")
```

---

## 🔐 Environment Variables

ApexRestpy is a library, not a CLI tool or service, so it does not ship its own `.env` file. For applications that use credentials, we recommend the following pattern:

**`.env.example`** — Reference this file in your project:

```env
# Oracle APEX Configuration
APEX_SCHEMA=your_schema_name
APEX_BASE_PATH=/pls/apex
APEX_HOST=apex.oracle.com
APEX_TIMEOUT=10

# Authentication
APEX_BEARER_TOKEN=your_jwt_or_oauth_token
```

**Usage:**

```python
import os
from dotenv import load_dotenv
from apex_restpy import ApexBridge

load_dotenv()

bridge = ApexBridge(
    schema=os.environ["APEX_SCHEMA"],
    host=os.environ.get("APEX_HOST", "apex.oracle.com"),
    timeout=float(os.environ.get("APEX_TIMEOUT", "10")),
)
bridge.set_token(os.environ["APEX_BEARER_TOKEN"])
```

> [!CAUTION]
> Never commit your `.env` file to Git. Our `.gitignore` already excludes it.

---

## 🧪 Testing

### Running the Tests

```bash
# Run all tests
pytest tests/ -v

# With a coverage report
pytest tests/ -v --cov=apex_restpy --cov-report=term-missing

# HTML coverage report
pytest tests/ --cov=apex_restpy --cov-report=html
open htmlcov/index.html
```

### Test Matrix

```
tests/
└── test_apex_bridge.py               38 tests
    ├── TestPrepareUrl                  4 tests  — URL construction logic
    ├── TestAddParameter                5 tests  — Query string management
    ├── TestAddPath                     3 tests  — Path appending
    ├── TestSetToken                    4 tests  — Token and header management
    ├── TestSendRequestGet              5 tests  — GET requests
    ├── TestSendRequestPost             3 tests  — POST requests and payload
    ├── TestSendRequestOtherMethods     4 tests  — PUT / PATCH / DELETE
    ├── TestErrorHandling               3 tests  — Error handling
    ├── TestBuildFullUrl                3 tests  — URL normalisation
    └── TestProperties                  4 tests  — Read-only properties
```

> [!TIP]
> All tests mock HTTP using `unittest.mock.MagicMock`. No real APEX server or network connection is required.

### Lint & Type Checking

```bash
# Lint
ruff check .

# Format check
ruff format --check .

# Auto-fix formatting
ruff format .

# Type checking
mypy apex_restpy --ignore-missing-imports
```

---

## 🤝 Contributing

We warmly welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for the detailed guide.

### Quick Start

```bash
# 1. Fork and clone
git clone https://github.com/<your-username>/ApexRestpy.git
cd ApexRestpy

# 2. Set up the development environment
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"

# 3. Create a feature branch
git checkout -b feat/my-feature

# 4. Make your changes and run the tests
pytest tests/ -v

# 5. Lint and format check
ruff check . && ruff format --check . && mypy apex_restpy

# 6. Write your commit message in Conventional Commits format
git commit -m "feat: add retry mechanism for connection failures"

# 7. Open a PR
git push origin feat/my-feature
```

### Commit Message Conventions

This project uses the [Conventional Commits](https://www.conventionalcommits.org/) standard:

| Prefix | Usage |
|---|---|
| `feat:` | New feature |
| `fix:` | Bug fix |
| `docs:` | Documentation only |
| `test:` | Adding or fixing tests |
| `refactor:` | Code restructuring |
| `chore:` | Dependency updates, CI |
| `BREAKING CHANGE:` | Backwards-incompatible change |

> Release Please analyses these messages to automatically generate a CHANGELOG and assign version numbers.

### Code Standards

- **Formatter:** Ruff (`line-length = 100`)
- **Linter:** Ruff (rules `E, W, F, I, B, UP`)
- **Type checking:** mypy (`warn_return_any = true`)
- **Test coverage:** Unit tests are mandatory for new features
- **Docstrings:** All public methods must have Google-style docstrings

---

## 🔒 Security Policy

For security vulnerability reports, please read [SECURITY.md](SECURITY.md).

**In brief:** Report vulnerabilities directly to `atacanymc@gmail.com`, not via GitHub Issues. A fix is committed within 90 days.

---

## 📜 License & Contact

This project is distributed under the **Apache License**. See the [LICENSE](LICENSE) file for details.

---

<div align="center">

**Ata Can Yaymacı**

[![Medium](https://img.shields.io/badge/Medium-%40atacanymc-black?logo=medium)](https://medium.com/@atacanymc)
[![GitHub](https://img.shields.io/badge/GitHub-AtaCanYmc-181717?logo=github)](https://github.com/AtaCanYmc)
[![Email](https://img.shields.io/badge/Email-atacanymc%40gmail.com-D14836?logo=gmail&logoColor=white)](mailto:atacanymc@gmail.com)

---

*C++ original: [ApexBridge](https://github.com/AtaCanYmc/ApexBridge) — Arduino library for ESP32/ESP8266*

⭐ If you find this useful, don't forget to star it on GitHub!

</div>
