Skip to content

Releases: PPeitsch/bcra-connector

v0.4.1

29 Dec 00:26
8170192
Compare
Choose a tag to compare

BCRA API Connector v0.4.1 introduces significant improvements to the test suite and library reliability.

Key Changes:

1. Test Coverage Updates

  • Added unit tests for all major components
  • Implemented integration tests for BCRA API endpoints
  • Improved testing for principales_variables, cheques, and estadisticas_cambiarias modules
  • Enhanced type annotations across test infrastructure

2. Reliability Improvements

  • Refined rate limiter implementation
  • Improved error handling and rate limiting test scenarios
  • Fixed intermittent test failures
  • Enhanced SSL and timeout error handling tests

3. Code Quality

  • Improved test suite organization
  • Enhanced error message validation
  • Refined rate limiter state tracking logic

These updates improve the reliability and maintainability of the BCRA API Connector by providing robust test coverage and addressing potential edge cases.

Upgrading

To update to the latest version, use pip:

pip install --upgrade bcra-connector

Additional Information

For a full list of changes, please refer to the CHANGELOG file in ReadTheDocs.

Thank you for using BCRA API Connector. If you encounter any issues or have any questions, please don't hesitate to open an issue on our GitHub repository.

We appreciate your continued support and feedback as we work to improve the BCRA API Connector.

v0.4.0

25 Nov 23:01
0fbcf19
Compare
Choose a tag to compare

We are excited to announce the release of BCRA API Connector v0.3.4, introducing important improvements to our PyPI publishing process.

Key Changes:

  1. PyPI Publishing Enhancements

    • Implemented trusted publishing using official PyPA action
    • Enhanced security through PyPI trusted publishing workflow
    • Updated GitHub Actions configuration for better reliability
  2. Build Process Improvements

    • Maintained build consistency using hatch
    • Optimized dependency management in publishing workflow
    • Streamlined test execution in publishing stage
  3. GitHub Actions Configuration

    • Added PyPI environment configuration
    • Configured necessary GitHub permissions for secure publishing
    • Improved test execution reliability
    • Optimized CI/CD pipeline efficiency

Usage

To update to the latest version, you can use pip:

pip install --upgrade bcra-connector

v0.3.3

06 Nov 21:49
549c92b
Compare
Choose a tag to compare

We are excited to announce the release of BCRA API Connector v0.3.3. This release introduces important new features for better API interaction control and reliability.

Key Changes:

1. Rate Limiting

  • Implemented flexible rate limiting with configurable thresholds
  • Added support for burst handling
  • Introduced RateLimitConfig class for easy rate limit customization
  • Thread-safe implementation for concurrent usage

2. Enhanced Timeout Management

  • Added new TimeoutConfig class for fine-grained timeout control
  • Separate connect and read timeout configuration
  • Smart default values based on API response patterns
  • Improved timeout error handling and reporting

3. Improved Reliability

  • Better error handling for network timeouts and rate limits
  • Enhanced logging for request timing and rate limiting events
  • Comprehensive test coverage for new features
  • Thread-safe implementations throughout

Usage Examples

Rate Limiting Configuration

from bcra_connector import BCRAConnector, RateLimitConfig

# Custom rate limiting
rate_config = RateLimitConfig(
    calls=10,    # 10 calls
    period=1.0,  # per second
    burst=20     # allow bursts of up to 20 calls
)

connector = BCRAConnector(rate_limit=rate_config)

Timeout Configuration

from bcra_connector import BCRAConnector, TimeoutConfig

# Custom timeouts
timeout_config = TimeoutConfig(
    connect=5.0,  # 5 seconds for connection
    read=30.0     # 30 seconds for reading
)

# Or use a simple total timeout
connector = BCRAConnector(timeout=15.0)  # 15 seconds total

Upgrading

To update to the latest version, you can use pip:

pip install --upgrade bcra-connector

Additional Information

For a full list of changes, please refer to the CHANGELOG file in ReadTheDocs.

Thank you for using BCRA API Connector. If you encounter any issues or have any questions, please don't hesitate to open an issue on our GitHub repository.

We appreciate your continued support and feedback as we work to improve the BCRA API Connector.

v0.3.2

06 Nov 20:29
144d6a3
Compare
Choose a tag to compare

We are pleased to announce the release of BCRA API Connector v0.3.2. This release focuses on project structure improvements and package configuration enhancements.

Key Changes:

1. Package Configuration

  • Updated package configuration to modern standards
  • Removed deprecated setup.py in favor of pyproject.toml
  • Enhanced version management system with better validation

2. Documentation & Structure

  • Added comprehensive CHANGELOG.md following Keep a Changelog format
  • Improved code organization and modularity
  • Enhanced project structure documentation
  • Updated package metadata for better PyPI presentation

These updates improve the maintainability and documentation of the BCRA API Connector, making it easier for users and contributors to work with the package.

Upgrading

To update to the latest version, you can use pip:

pip install --upgrade bcra-connector

Additional Information

For a full list of changes, please refer to the CHANGELOG file in ReadTheDocs.

Thank you for using BCRA API Connector. If you encounter any issues or have any questions, please don't hesitate to open an issue on our GitHub repository.

We appreciate your continued support and feedback as we work to improve the BCRA API Connector.

v0.3.1

09 Oct 02:31
df72856
Compare
Choose a tag to compare

: Documentation Enhancements

We are pleased to announce the release of BCRA API Connector v0.3.1. This release focuses on significant improvements to our documentation, enhancing the user experience and providing clearer guidance on using the library.

Key Changes:

  1. Documentation Updates:

    • Updated API reference to include detailed information about Cheques and Estadísticas Cambiarias modules
    • Enhanced usage guide with examples for all modules
    • Revised main documentation page to reflect the full range of features
    • Added bilingual README (English and Spanish)
  2. Minor Fixes:

    • Corrected inconsistencies in documentation
    • Improved clarity and readability throughout the documentation

These documentation improvements make it easier for users to understand and utilize all features of the BCRA API Connector, including the Cheques and Estadísticas Cambiarias modules added in the previous release.

Upgrading

To update to the latest version, you can use pip:

pip install --upgrade bcra-connector

Additional Information

For a full list of changes, please refer to the CHANGELOG file in ReadTheDocs.

Thank you for using BCRA API Connector. If you encounter any issues or have any questions, please don't hesitate to open an issue on our GitHub repository.

We appreciate your continued support and feedback as we work to improve the BCRA API Connector.

v0.3.0

08 Oct 02:47
df72856
Compare
Choose a tag to compare

We are excited to announce the release of BCRA API Connector v0.3.0. This release introduces significant enhancements to our API coverage and improvements to existing modules.

Key Changes:

  1. New Modules:

    • Added Cheques module for interacting with the BCRA Cheques API
    • Added Estadísticas Cambiarias module for currency exchange rate data
  2. Enhanced Functionality:

    • Improved error handling and response parsing for all API endpoints
    • Added comprehensive type hinting for better code readability and IDE support
  3. Expanded Test Coverage:

    • Implemented extensive unit tests for new and existing modules
    • Improved test structure for easier maintenance and future expansion
  4. Documentation Updates:

    • Updated API reference to include new modules and endpoints
    • Added usage examples for Cheques and Estadísticas Cambiarias APIs
  5. Code Refactoring:

    • Improved code organization and modularity
    • Enhanced consistency across all API interaction classes

These updates significantly expand the capabilities of the BCRA API Connector, providing access to a wider range of BCRA data and services.

Upgrading

To update to the latest version, you can use pip:

pip install --upgrade bcra-connector

Additional Information

For a full list of changes, please refer to the CHANGELOG file in ReadTheDocs.

Thank you for using BCRA API Connector. If you encounter any issues or have any questions, please don't hesitate to open an issue on our GitHub repository.

We appreciate your continued support and feedback as we work to improve the BCRA API Connector.

v0.2.0

07 Sep 04:46
6946573
Compare
Choose a tag to compare

We are pleased to announce the release of BCRA API Connector v0.2.0. This release focuses on significant improvements to our documentation and minor updates to enhance the user experience.

Key Changes:

  1. Documentation Enhancements:

    • Comprehensive revision of all documentation files for improved clarity and readability
    • Expanded installation guide covering various installation methods
    • Updated and improved usage examples
    • New contributing guidelines to encourage community participation
    • Enhanced API reference documentation with more detailed descriptions
  2. Configuration Updates:

    • Revised Read the Docs configuration for better documentation building
    • Updated project metadata and version information
  3. Minor Fixes:

    • Corrected inconsistencies in version numbering across project files
    • Fixed links and references in documentation files

These updates significantly improve the usability and understandability of the BCRA API Connector. While no major functional changes were made to the core connector, these documentation improvements should make it easier for users to get started and make the most of the library.

Upgrading

To update to the latest version, you can use pip:

pip install --upgrade bcra-connector

Additional Information

For a full list of changes, please refer to the CHANGELOG file in ReadTheDocs.

Thank you for using BCRA API Connector. If you encounter any issues or have any questions, please don't hesitate to open an issue on our GitHub repository.

We appreciate your continued support and feedback as we work to improve the BCRA API Connector.

v0.1.1

29 Aug 21:14
6b7ae67
Compare
Choose a tag to compare

Security Updates and Dependency Upgrades

We are pleased to announce the release of BCRA API Connector v0.1.1. This release focuses on important security updates and dependency upgrades to ensure the stability and security of the connector.

Key Changes:

  1. Security Enhancements:

    • Updated requests to version 2.32.0 or higher to address a security vulnerability
    • Addressed potential SSL verification issue with the requests library
  2. Dependency Upgrades:

    • Updated matplotlib to version 3.7.3 or higher
    • Updated setuptools to version 70.0.0 or higher
    • Updated urllib3 to version 2.2.1 or higher

These updates improve the overall security and compatibility of the BCRA API Connector. We strongly recommend all users to upgrade to this version.

To update, you can use pip:

pip install --upgrade bcra-connector

For a full list of changes, please refer to the CHANGELOG.rst file in the repository.

Thank you for using BCRA API Connector. If you encounter any issues or have any questions, please don't hesitate to open an issue on our GitHub repository.

v0.1.0

25 Aug 17:49
8db5af3
Compare
Choose a tag to compare

Changelog

All notable changes to the BCRA API Connector will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

0.1.0 - 2024-08-25

Added

  • Initial release of the BCRA API Connector
  • BCRAConnector class for interacting with the BCRA API
  • Functionality to fetch principal variables (get_principales_variables)
  • Historical data retrieval (get_datos_variable)
  • Latest value fetching (get_latest_value)
  • Custom exception BCRAApiError for error handling
  • Retry logic with exponential backoff
  • SSL verification toggle
  • Debug mode for detailed logging

Requirements

  • Python 3.9 or higher

Documentation

  • README with project overview and basic usage
  • Comprehensive API documentation
  • Usage examples for all main features
  • Installation guide

Examples

  • Scripts demonstrating various use cases:
    • Fetching and visualizing principal variables
    • Retrieving and plotting historical data
    • Comparing latest values for multiple variables
    • Error handling scenarios
    • Different connector configurations

Development

  • Project structure set up for future expansion
  • Basic error handling and logging implemented
  • Foundation laid for future testing framework