Skip to content

v1.0.0 - First Official Release

Latest
Latest

Choose a tag to compare

View all tags
@stevenaubertin stevenaubertin released this 16 Nov 05:30
· 1 commit to main since this release
v1.0.0
1011641
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

OMDB API Python Wrapper v1.0.0 🎉

First official release! This release transforms the OMDB API wrapper into a professional, production-ready Python package.

🚀 Quick Install

pip install https://github.com/stevenaubertin/omdb-api-python-wrapper/releases/download/v1.0.0/omdb-api-wrapper-1.0.0.tar.gz

Or download the tarball and install:

pip install omdb-api-wrapper-1.0.0.tar.gz

✨ Highlights

Package Features

  • ✅ Professional package structure - Proper Python package with clean imports
  • ✅ Console script - omdb-search command available after installation
  • ✅ Comprehensive tests - 40+ tests with 95%+ coverage
  • ✅ Code quality tools - Black, Flake8, isort, mypy all configured
  • ✅ Complete documentation - README, CLAUDE.md, and API docs

Installation & Usage

Setup:

pip install omdb-api-wrapper-1.0.0.tar.gz
cp .env.example .env
# Add your OMDB API key to .env

CLI Usage:

omdb-search --search "The Matrix"
omdb-search --id tt0133093

Python API:

from omdb_api import get_movie_by_id_or_title, search_movies

movie = get_movie_by_id_or_title(title="Inception")
results = search_movies("Batman", year=2008)

📦 What's Included

  • Package: Source distribution (.tar.gz)
  • Tests: 40+ comprehensive tests
  • Docs: Complete user and developer documentation
  • Tools: All code quality tools pre-configured

🔧 Key Improvements

  • Renamed to valid Python package name (omdb_api)
  • Added comprehensive test suite with pytest
  • Added packaging configuration (setup.py, pyproject.toml)
  • Added code quality tools (Black, Flake8, isort, mypy)
  • Added extensive documentation (CLAUDE.md v2.0.0)
  • Fixed filename typo (result-example.json)
  • Added console script entry point

📚 Documentation

  • README.md - User guide with examples
  • CLAUDE.md - Comprehensive development guide
  • RELEASE_NOTES.md - Detailed release information

🧪 Testing

All tests passing with 95%+ coverage:

pytest --cov=omdb_api

⚠️ Breaking Changes

  • Directory renamed: omdb-api/ → omdb_api/
  • Now requires proper installation (no longer just copy files)
  • CLI usage changed to omdb-search command

📋 Requirements

  • Python 3.7+
  • requests>=2.31.0
  • python-dotenv>=1.0.0
  • OMDB API key (free at omdbapi.com)

🔗 Links

Full Changelog: Initial release - all features are new!

Assets 3
Loading