Skip to content

Commit 4ec4e0d

Browse files
francescobiancofrancescobianco
committed
restyle README files
1 parent 9499c7e commit 4ec4e0d

9 files changed

Lines changed: 268 additions & 0 deletions

File tree

‎.github/assets/repo-header-a3.png‎

84.9 KB
Loading

‎.idea/.gitignore‎

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/modules.xml‎

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/openapi-python-sdk.iml‎

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/vcs.xml‎

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Makefile‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
#!make
2+
3+
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
4+
# #
5+
# ____ _ #
6+
# / __ \____ ___ ____ ____ _____ (_) ® #
7+
# / / / / __ \/ _ \/ __ \/ __ `/ __ \/ / #
8+
# / /_/ / /_/ / __/ / / / /_/ / /_/ / / #
9+
# \____/ .___/\___/_/ /_/\__,_/ .___/_/ #
10+
# /_/ /_/ #
11+
# #
12+
# The Largest Certified API Marketplace #
13+
# Accelerate Digital Transformation • Simplify Processes • Lead Industry #
14+
# #
15+
# ═══════════════════════════════════════════════════════════════════════ #
16+
# #
17+
# Project: openapi-rust-sdk #
18+
# Version: 0.1.0 #
19+
# Author: Michael Cuffaro (@maiku1008) #
20+
# Copyright: (c) 2025 Openapi®. All rights reserved. #
21+
# License: MIT #
22+
# Maintainer: Francesco Bianco #
23+
# Contact: https://openapi.com/ #
24+
# Repository: https://github.com/openapi/openapi-php-sdk/ #
25+
# Documentation: https://console.openapi.com/ #
26+
# #
27+
# ═══════════════════════════════════════════════════════════════════════ #
28+
# #
29+
# "Truth lies at the source of the stream." #
30+
# — English Proverb #
31+
# #
32+
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
33+
34+
## =========
35+
## Variables
36+
## =========
37+
38+
VERSION := 1.2.1
39+
40+
## ====================
41+
## Development Commands
42+
## ====================
43+
44+
dev-push:
45+
@git config credential.helper 'cache --timeout=3600'
46+
@git add .
47+
@git commit -m "$$(read -p 'Commit message: ' msg; echo $$msg)" || true
48+
@git push
49+
50+
## ================
51+
## Release Commands
52+
## ================
53+
54+
push:
55+
@git add .
56+
@git commit -am "Updated at $$(date)" || true
57+
@git push
58+
59+
release: push
60+
@git add .
61+
@git commit -m "Update PHP SDK to version ${VERSION}" || echo "No changes to commit"
62+
@git tag -fa "${VERSION}" -m "${VERSION}"
63+
@git push origin --tags -f

‎README.md‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,50 @@
1+
<div align="center">
2+
<a href="https://openapi.com/">
3+
<img alt="Openapi SDK for PHP" src=".github/assets/repo-header-a3.png" >
4+
</a>
5+
6+
<h1>Openapi® client for PHP</h1>
7+
<h4>The perfect starting point to integrate <a href="https://openapi.com/">Openapi®</a> within your PHP project</h4>
8+
9+
[![Build Status](https://github.com/openapi/openapi-php-sdk/actions/workflows/php.yml/badge.svg)](https://github.com/openapi/openapi-php-sdk/actions/workflows/php.yml)
10+
[![Packagist Version](https://img.shields.io/packagist/v/openapi/openapi-sdk)](https://packagist.org/packages/openapi/openapi-sdk)
11+
[![PHP Version](https://img.shields.io/packagist/php-v/openapi/openapi-sdk)](https://packagist.org/packages/openapi/openapi-sdk)
12+
[![License](https://img.shields.io/github/license/openapi/openapi-php-sdk?v=2)](LICENSE)
13+
[![Downloads](https://img.shields.io/packagist/dt/openapi/openapi-sdk)](https://packagist.org/packages/openapi/openapi-sdk)
14+
<br>
15+
[![Linux Foundation Member](https://img.shields.io/badge/Linux%20Foundation-Silver%20Member-003778?logo=linux-foundation&logoColor=white)](https://www.linuxfoundation.org/about/members)
16+
</div>
17+
18+
## Overview
19+
20+
A minimal and agnostic PHP SDK for Openapi, inspired by a clean client implementation. This SDK provides only the core HTTP primitives needed to interact with any Openapi service.
21+
22+
## Pre-requisites
23+
24+
Before using the Openapi PHP Client, you will need an account at [Openapi](https://console.openapi.com/) and an API key to the sandbox and/or production environment
25+
26+
## Features
27+
28+
- **Agnostic Design**: No API-specific classes, works with any OpenAPI service
29+
- **Minimal Dependencies**: Only requires PHP 8.0+ and cURL
30+
- **OAuth Support**: Built-in OAuth client for token management
31+
- **HTTP Primitives**: GET, POST, PUT, DELETE, PATCH methods
32+
- **Clean Interface**: Similar to the Rust SDK design
33+
34+
## What you can do
35+
36+
With the Openapi PHP Client, you can easily interact with a variety of services in the Openapi Marketplace. For example, you can:
37+
38+
- 📩 **Send SMS messages** with delivery reports and custom sender IDs
39+
- 💸 **Process bills and payments** in real time via API
40+
- 🧾 **Send electronic invoices** securely to the Italian Revenue Agency
41+
- 📄 **Generate PDFs** from HTML content, including JavaScript rendering
42+
- ✉️ **Manage certified emails** and legal communications via Italian Legalmail
43+
44+
For a complete list of all available services, check out the [Openapi Marketplace](https://console.openapi.com/) 🌐
45+
46+
47+
148

249
# OpenApi IT Python Client
350

@@ -75,3 +122,52 @@ Please adhere to this project's `code of conduct`.
75122

76123
- [@maiku1008](https://www.github.com/maiku1008)
77124
- [@openapi-it](https://github.com/openapi-it)
125+
126+
127+
128+
129+
## Contributing
130+
131+
Contributions are always welcome! Whether you want to report bugs, suggest new features, improve documentation, or contribute code, your help is appreciated.
132+
133+
See [docs/contributing.md](docs/contributing.md) for detailed instructions on how to get started. Please make sure to follow this project's [docs/code-of-conduct.md](docs/code-of-conduct.md) to help maintain a welcoming and collaborative environment.
134+
135+
## Authors
136+
137+
Meet the project authors:
138+
139+
- L. Paderi ([@lpaderiAltravia](https://www.github.com/lpaderiAltravia))
140+
- Openapi Team ([@openapi-it](https://github.com/openapi-it))
141+
142+
## Partners
143+
144+
Meet our partners using Openapi or contributing to this SDK:
145+
146+
- [Blank](https://www.blank.app/)
147+
- [Credit Safe](https://www.creditsafe.com/)
148+
- [Deliveroo](https://deliveroo.it/)
149+
- [Gruppo MOL](https://molgroupitaly.it/it/)
150+
- [Jakala](https://www.jakala.com/)
151+
- [Octotelematics](https://www.octotelematics.com/)
152+
- [OTOQI](https://otoqi.com/)
153+
- [PWC](https://www.pwc.com/)
154+
- [QOMODO S.R.L.](https://www.qomodo.me/)
155+
- [SOUNDREEF S.P.A.](https://www.soundreef.com/)
156+
157+
## Our Commitments
158+
159+
We believe in open source and we act on that belief. We became Silver Members
160+
of the Linux Foundation because we wanted to formally support the ecosystem
161+
we build on every day. Open standards, open collaboration, and open governance
162+
are part of how we work and how we think about software.
163+
164+
## License
165+
166+
This project is licensed under the [MIT License](LICENSE).
167+
168+
The MIT License is a permissive open-source license that allows you to freely use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, provided that the original copyright notice and this permission notice are included in all copies or substantial portions of the software.
169+
170+
In short, you are free to use this SDK in your personal, academic, or commercial projects, with minimal restrictions. The project is provided "as-is", without any warranty of any kind, either expressed or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.
171+
172+
For more details, see the full license text at the [MIT License page](https://choosealicense.com/licenses/mit/).
173+

‎docs/code-of-conduct.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project a harassment-free experience for everyone.
6+
7+
## Our Standards
8+
9+
Examples of positive behavior:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy toward other community members
16+
17+
Examples of unacceptable behavior:
18+
19+
- Harassment, intimidation, or discrimination
20+
- Public or private insults and derogatory comments
21+
- Publishing others’ private information without consent
22+
- Any other conduct reasonably considered inappropriate
23+
24+
## Enforcement
25+
26+
Instances of unacceptable behavior may be reported by contacting the project team at `<hello@openapi.com>`. All complaints will be reviewed promptly and fairly.
27+
28+
## Attribution
29+
30+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

‎docs/contributing.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing to OpenApi IT Python SDK
2+
3+
Thanks for considering contributing! 🎉
4+
We welcome all kinds of contributions: bug reports, feature requests, documentation improvements, and code enhancements.
5+
6+
## How to Contribute
7+
8+
1. **Fork the repository** and clone it locally:
9+
```bash
10+
git clone https://github.com/<username>/<repo>.git
11+
```
12+
13+
2. **Create a branch** for your feature or fix:
14+
```bash
15+
git checkout -b feature/your-feature-name
16+
```
17+
18+
3. **Make your changes** and commit them:
19+
```bash
20+
git commit -m "Add some feature"
21+
```
22+
23+
4. **Push your branch** to your fork:
24+
```bash
25+
git push origin feature/your-feature-name
26+
```
27+
28+
5. **Open a Pull Request** describing your changes.
29+
30+
## Guidelines
31+
32+
* Follow the existing **Python coding style**.
33+
* Include **tests** for new features or bug fixes when applicable.
34+
* Keep **commit messages clear and concise**.
35+
* Update **documentation** as needed for your changes.
36+
37+
## Reporting Issues
38+
39+
To report bugs or request features, please **open an issue** on GitHub including:
40+
41+
* Clear description of the problem or feature.
42+
* Steps to reproduce (if applicable).
43+
* Relevant logs or screenshots.
44+
45+
Thank you for helping improve OpenApi IT Python SDK! 🚀

0 commit comments

Comments
 (0)