Initial commit

.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -0,0 +1,60 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+
+# IDEs
+.vscode/
+.idea/
+
+api_specs/
+
+wallet_output/
+service_output/

CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contributing to Zarban SDK
+
+We appreciate your interest in contributing to the Zarban SDK! Contributions are key to improving our project, and we welcome bug reports, feature requests, and pull requests.
+
+## How to Contribute
+
+### 1. Fork the Repository
+
+- Start by [forking the repository](https://github.com/zarbanio/zarban-py/fork).
+
+### 2. Clone Your Fork
+
+```bash
+git clone https://github.com/your-username/zarban-py.git
+cd zarban-py
+```
+
+### 3. Create a New Branch
+
+Use a descriptive branch name, e.g., `feature/feature-name` or `fix/issue-description`.
+
+```bash
+git checkout -b feature/your-feature
+```
+
+### 4. Make Your Changes
+
+Ensure that your code is well-documented.
+Follow the project's code style and structure.
+
+### 5. Run Tests
+
+Run the tests to make sure everything works as expected.
+
+### 6. Commit Your Changes
+
+Add a meaningful commit message. Refer to issues by their number if applicable (e.g., #123).
+
+```bash
+git commit -m "Add feature: detailed feature description"
+```
+
+### 7. Push Your Changes
+
+```bash
+git push origin feature/your-feature
+```
+
+### 8. Open a Pull Request
+
+- Go to the original repository on GitHub.
+- Click on **New Pull Request**.
+- Select the branch you just pushed from the dropdown menu.
+- Add a descriptive title and summary of your changes.
+- Reference any relevant issues (e.g., `#123`).
+
+markdown
+
+## Reporting Bugs
+
+If you encounter a bug, please help us improve the Zarban SDK by reporting it.
+
+- **Search Existing Issues**: Before submitting, check the [GitHub Issues](https://github.com/zarbanio/zarban-py/issues) to see if the problem has already been reported.
+- **Open a New Issue**: If the issue is not reported, open a new issue and provide the following details:
+  - A clear description of the bug.
+  - Steps to reproduce the issue.
+  - Expected and actual behavior.
+  - Relevant error messages or screenshots, if applicable.
+  - Version of Zarban SDK you are using.
+
+## Code Style
+
+Please ensure your code adheres to PEP 8 and includes type hints where possible.
+
+Thank you for your contribution!

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] Zarban
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include src/zarban *.py