Skip to content

Latest commit

 

History

History
76 lines (54 loc) · 2.89 KB

CHANGELOG.md

File metadata and controls

76 lines (54 loc) · 2.89 KB

Changelog

All notable changes to pycgapi will be documented in this file.

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

[Unreleased]

  • Asynchronous functionality for enhanced performance (planned).
  • Refactoring of codebase for improved maintainability (planned).

[0.1.5] - 2024-01-17

Fixed

  • Updated README.md to fix "bitoin" typo to "bitcoin".

[0.1.4] - 2024-01-10

Added

  • Tested compatibility with Python 3.9, 3.10, and 3.11.
  • Added a .dockerignore file to exclude unnecessary files from the Docker image.
  • Added *.bat files to .gitignore and .dockerignore.

[0.1.3] - 2024-01-10

Updated

  • Updated tests to improve test coverage.
  • Added downloads and platforms badges to README.md and index.rst.

[0.1.2] - 2024-01-10

Fixed

  • Updated README.md to fix logo display issue.

[0.1.1] - 2024-01-10

Added

  • Automated GitHub workflow for Pypi package release.
  • Separation of different GitHub workflows into their individual .yml files.
  • Creation of __version__.py to maintain a single source of truth for the project's version number.
  • Updates to README.md and index.rst for correcting hyperlinks to examples.
  • Inclusion of sphinx in requirements.txt for documentation support.

Updated

  • Corrected badge links in README.md and index.rst to point to the updated tests.yml workflow, ensuring accuracy in workflow status representation.
  • Enhanced conf.py with additional settings to improve documentation generation.
  • Made specific updates to docs/source/index.rst to refine the workflow badge link, maintaining the accuracy and relevance of project documentation.
  • Edited the README.md and index.rst files to include a change log section.

Fixed

  • Updated release.yml workflow to add required build dependencies.

[0.1.0] - 2024-01-08

Added

  • Initial release of pycgapi, an unofficial Python wrapper for the CoinGecko API (V3).
  • Simplified endpoint access for easy integration with Python applications.
  • Comprehensive data access for over thousands of cryptocurrencies.
  • Enhanced functionality for Pro users with access to exclusive data sets.
  • Support for multiple categories including coins, exchanges, derivatives, DeFi, and NFTs.
  • Historical data retrieval and global cryptocurrency statistics.
  • Efficient rate limit management and comprehensive error handling.
  • Real-time data updates for timely analysis and decision-making.
  • Integration with keyring for secure API key storage.
  • Docker support for containerized application deployment.
  • Extensive documentation for all methods and usage examples.
  • Roadmap outlining future enhancements.
  • License file under MIT License.
  • Contribution guidelines for community involvement.

Fixed

  • Comprehensive testing for all functionalities ensuring robust performance.