A Python SDK and CLI for interacting with SOA WebServices API (SOAWebservices Web Site)
- Clone the repository
- Install dependencies:
pip install -r requirements.txt- Configure environment variables in
.env:
BASE_URL=https://homologacao.soawebservices.com.br
PROD_BASE_URL=https://services.soawebservices.com.br
EMAIL=<your-sowawebservices-username>
PASSWORD=<your-sowawebservices-password>
from soa_sdk.client import SOAWebServicesClient
# Initialize client
client = SOAWebServicesClient()
# Get account balance
balance = client.get_saldo()
# Get synthetic statement
statement = client.get_extrato_sintetico(2023, 12)
# Get NFe information for individual
nfe = client.get_pessoa_fisica_nfe("12345678900", "1990-01-01")# Get account balance
soa-cli saldo
# Get synthetic statement
soa-cli extrato-sintetico --ano 2023 --mes 12
# Get NFe information for individual
# Get NFe information for company
soa-cli pessoa-juridica-nfe --documento 12345678000190- Complete API coverage
- Automatic logging to file and console
- Type validation using Pydantic
- Rich CLI interface
- Environment-based configuration
Logs are written to logs/soa_sdk.log and rotated when they reach 10MB in size. The last 5 log files are kept.
The SDK includes comprehensive error handling and logging. All API errors are logged and raised as exceptions.
- Fork the repository
- Create a new branch (
git checkout -b feature-branch) - Make your changes
- Commit your changes (
git commit -m 'Add new feature') - Push to the branch (
git push origin feature-branch) - Open a Pull Request