File tree Expand file tree Collapse file tree 2 files changed +72
-4
lines changed
Expand file tree Collapse file tree 2 files changed +72
-4
lines changed Original file line number Diff line number Diff line change 1+ # Contributing to Veria Python SDK
2+
3+ Thank you for your interest in contributing to the Veria SDK! We welcome contributions from the community.
4+
5+ ## Getting Started
6+
7+ 1 . Fork the repository
8+ 2 . Clone your fork: ` git clone https://github.com/YOUR_USERNAME/veria-python.git `
9+ 3 . Create a virtual environment: ` python -m venv venv && source venv/bin/activate `
10+ 4 . Install dev dependencies: ` pip install -e ".[dev]" `
11+ 5 . Create a branch: ` git checkout -b feature/your-feature-name `
12+
13+ ## Development
14+
15+ ### Testing
16+
17+ ``` bash
18+ pytest
19+ ```
20+
21+ ### Code Style
22+
23+ - We follow PEP 8 guidelines
24+ - Use type hints for all public APIs
25+ - Use meaningful variable and function names
26+ - Add docstrings for public functions and classes
27+
28+ ### Linting
29+
30+ ``` bash
31+ ruff check .
32+ mypy src/
33+ ```
34+
35+ ## Pull Request Process
36+
37+ 1 . Ensure your code passes all tests and linting
38+ 2 . Update documentation if needed
39+ 3 . Add a clear description of your changes
40+ 4 . Reference any related issues
41+
42+ ## Reporting Issues
43+
44+ When reporting issues, please include:
45+
46+ - SDK version (` pip show veria ` )
47+ - Python version
48+ - Operating system
49+ - Minimal reproduction steps
50+ - Expected vs actual behavior
51+
52+ ## Questions?
53+
54+ - Open a GitHub issue for bugs or feature requests
55+ - Email support@veria.cc for general questions
56+
57+ ## License
58+
59+ By contributing, you agree that your contributions will be licensed under the MIT License.
Original file line number Diff line number Diff line change 11# Veria SDK for Python
22
3+ [ ![ PyPI version] ( https://img.shields.io/pypi/v/veria.svg )] ( https://pypi.org/project/veria/ )
4+ [ ![ PyPI downloads] ( https://img.shields.io/pypi/dm/veria.svg )] ( https://pypi.org/project/veria/ )
5+ [ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-yellow.svg )] ( https://opensource.org/licenses/MIT )
6+ [ ![ Python versions] ( https://img.shields.io/pypi/pyversions/veria.svg )] ( https://pypi.org/project/veria/ )
7+
38Official SDK for the [ Veria Compliance API] ( https://veria.cc ) - screen wallet addresses for sanctions, PEP, and AML compliance.
49
510## Installation
@@ -13,7 +18,7 @@ pip install veria
1318``` python
1419from veria import VeriaClient
1520
16- client = VeriaClient(api_key = " veria_live_xxxxxxxxxxxx" ) # Get yours at https://protocol. veria.cc
21+ client = VeriaClient(api_key = " veria_live_xxxxxxxxxxxx" ) # Get yours at https://veria.cc/choose-plan
1722
1823# Screen an address
1924result = client.screen(" 0x742d35Cc6634C0532925a3b844Bc454e4438f44e" )
@@ -195,11 +200,15 @@ class ComplianceMiddleware:
195200 return self .get_response(request)
196201```
197202
203+ ## Contributing
204+
205+ We welcome contributions! Please see [ CONTRIBUTING.md] ( CONTRIBUTING.md ) for guidelines.
206+
198207## Resources
199208
200- - [ Documentation] ( https://docs. veria.cc )
201- - [ API Reference] ( https://docs. veria.cc/api )
202- - [ Get API Key] ( https://protocol. veria.cc )
209+ - [ Documentation] ( https://veria.cc/protocol/docs )
210+ - [ API Reference] ( https://veria.cc/protocol/docs/reference )
211+ - [ Get API Key] ( https://veria.cc/choose-plan )
203212- [ GitHub] ( https://github.com/Veria-Protocol/veria-python )
204213
205214## License
You can’t perform that action at this time.
0 commit comments