chore: release version 1.0.0, marking the transition from beta to stable with updated documentation and installation instructions

SirStig · SirStig · commit 7391bb3df3eb · 2026-03-23T21:07:01.000-06:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -33,7 +33,7 @@ Paste any error messages or stack traces here
 **Environment (please complete the following information):**
  - OS: [e.g. Ubuntu 20.04, Windows 10, macOS 12]
  - Python version: [e.g. 3.9.5]
- - YokedCache version: [e.g. 1.0.0-beta]
+ - YokedCache version: [e.g. 1.0.0]
  - Redis version: [e.g. 7.0.5]
  - FastAPI version: [e.g. 0.104.1]
 
diff --git a/.github/workflows/manual-release.yml b/.github/workflows/manual-release.yml
@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
     inputs:
       version:
-        description: 'Version to release (e.g., 1.0.0-beta)'
+        description: 'Version to release (e.g., 1.0.0)'
         required: true
         type: string
       prerelease:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,9 +5,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.0.0-beta] - 2026-03-23
+## [1.0.0] - 2026-03-23
 
-First beta toward 1.0.0. Focus: security hardening, safer Redis usage, and clearer HTTP cache semantics.
+First stable 1.x release. Published as **1.0.0** (not a PEP 440 pre-release) so a plain `pip install yokedcache` resolves to this line ahead of 0.x. Focus: security hardening, safer Redis usage, and clearer HTTP cache semantics.
 
 ### Security
 
@@ -134,8 +134,8 @@ First beta toward 1.0.0. Focus: security hardening, safer Redis usage, and clear
 
 - Initial release: core Redis cache, FastAPI-oriented usage, CLI, configuration, baseline documentation.
 
-[Unreleased]: https://github.com/sirstig/yokedcache/compare/v1.0.0-beta...HEAD
-[1.0.0-beta]: https://github.com/sirstig/yokedcache/compare/v0.3.0...v1.0.0-beta
+[Unreleased]: https://github.com/sirstig/yokedcache/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/sirstig/yokedcache/compare/v0.3.0...v1.0.0
 [0.3.0]: https://github.com/sirstig/yokedcache/compare/v0.2.4...v0.3.0
 [0.2.4]: https://github.com/sirstig/yokedcache/compare/v0.2.3...v0.2.4
 [0.2.3]: https://github.com/sirstig/yokedcache/compare/v0.2.1...v0.2.3
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -207,8 +207,8 @@ yokedcache/
 3. Create a release PR
 4. After merge, tag the release:
    ```bash
-   git tag -a v1.0.0-beta -m "Release version 1.0.0-beta"
-   git push origin v1.0.0-beta
+   git tag -a v1.0.0 -m "Release version 1.0.0"
+   git push origin v1.0.0
    ```
 5. GitHub Actions will automatically publish to PyPI
 
diff --git a/README.md b/README.md
@@ -24,16 +24,16 @@ Async-first Python caching for FastAPI and other asyncio services: Redis-oriente
 
 ## Installation
 
-Current release line: **1.0.0-beta** (pre-release on PyPI).
+Current stable line: **1.0.0** (default on PyPI).
 
 ```bash
-pip install "yokedcache==1.0.0-beta"
+pip install yokedcache
 ```
 
-For the latest pre-release without pinning:
+To require 1.x or newer:
 
 ```bash
-pip install --pre yokedcache
+pip install "yokedcache>=1.0.0"
 ```
 
 Optional extras:
@@ -84,7 +84,7 @@ Other backends impose their own dependencies when you install the matching extra
 
 ## Security
 
-Treat Redis and Memcached as **trusted** stores: anyone who can write arbitrary keys can affect deserialization. From **1.0.0-beta**, new values are written with a typed envelope; set `allow_legacy_insecure_deserialization=False` on `CacheConfig` once legacy entries are migrated. Do not use `HTTPCacheMiddleware` on authenticated routes without a `key_builder` that varies the key per user or session. See the changelog for details.
+Treat Redis and Memcached as **trusted** stores: anyone who can write arbitrary keys can affect deserialization. From **1.0.0**, new values are written with a typed envelope; set `allow_legacy_insecure_deserialization=False` on `CacheConfig` once legacy entries are migrated. Do not use `HTTPCacheMiddleware` on authenticated routes without a `key_builder` that varies the key per user or session. See the changelog for details.
 
 ## Development
 
diff --git a/examples/advanced_features_demo.py b/examples/advanced_features_demo.py
@@ -1,7 +1,7 @@
 """
 YokedCache Advanced Features Demo
 
-This example demonstrates advanced caching features in YokedCache 1.0.0-beta:
+This example demonstrates advanced caching features in YokedCache 1.0.0:
 - HTTP Response Middleware
 - Single-Flight Protection
 - Stale-While-Revalidate
diff --git a/examples/cache_config.yaml b/examples/cache_config.yaml
@@ -106,7 +106,7 @@ warm:
   # Predefined cache entries to warm on startup
   items:
     - key: "system:status"
-      value: {"status": "active", "version": "1.0.0-beta"}
+      value: {"status": "active", "version": "1.0.0"}
       ttl: 3600
       tags: ["system"]
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -36,7 +36,7 @@ keywords = [
     "cache management",
 ]
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
diff --git a/site-src/pages/cli.md b/site-src/pages/cli.md
@@ -8,7 +8,7 @@ The CLI is automatically available after installing YokedCache:
 
 ```bash
 # Install YokedCache
-pip install "yokedcache==1.0.0-beta"
+pip install "yokedcache==1.0.0"
 
 # Verify CLI installation
 yokedcache --version
diff --git a/site-src/pages/getting-started.md b/site-src/pages/getting-started.md
@@ -14,7 +14,7 @@ This guide will walk you through installing YokedCache and setting up your first
 
 ```bash
 # Install the core YokedCache package for Python FastAPI Redis caching
-pip install "yokedcache==1.0.0-beta"
+pip install "yokedcache==1.0.0"
 ```
 
 ### Recommended Installation for Production FastAPI Applications
@@ -23,7 +23,7 @@ For production FastAPI applications, install YokedCache with all Redis caching f
 
 ```bash
 # Install with all Redis caching features (recommended for FastAPI)
-pip install "yokedcache[full]==1.0.0-beta"
+pip install "yokedcache[full]==1.0.0"
 ```
 
 ### Feature-Specific Installation for Custom Python Setups
@@ -32,19 +32,19 @@ Install only the Redis caching features you need for your Python application:
 
 ```bash
 # Vector similarity search caching
-pip install "yokedcache[vector]==1.0.0-beta"
+pip install "yokedcache[vector]==1.0.0"
 
 # Production monitoring for Redis cache (Prometheus, StatsD)
-pip install "yokedcache[monitoring]==1.0.0-beta"
+pip install "yokedcache[monitoring]==1.0.0"
 
 # Memcached backend support
-pip install "yokedcache[memcached]==1.0.0-beta"
+pip install "yokedcache[memcached]==1.0.0"
 
 # Fuzzy search capabilities for cached data
-pip install "yokedcache[fuzzy]==1.0.0-beta"
+pip install "yokedcache[fuzzy]==1.0.0"
 
 # Combine multiple caching features
-pip install "yokedcache[vector,monitoring,fuzzy]==1.0.0-beta"
+pip install "yokedcache[vector,monitoring,fuzzy]==1.0.0"
 ```
 
 ## Prerequisites
@@ -498,7 +498,7 @@ pip list | grep yokedcache
 
 # Reinstall if needed
 pip uninstall yokedcache
-pip install "yokedcache[full]==1.0.0-beta"
+pip install "yokedcache[full]==1.0.0"
 ```
 
 ### Performance Issues
diff --git a/site-src/pages/monitoring.md b/site-src/pages/monitoring.md
@@ -143,7 +143,7 @@ The NoOpCollector allows you to disable metrics collection without changing your
 
 ```bash
 # Install Prometheus dependencies
-pip install "yokedcache[monitoring]==1.0.0-beta"
+pip install "yokedcache[monitoring]==1.0.0"
 
 # Or install manually
 pip install prometheus_client
@@ -221,7 +221,7 @@ collector = PrometheusCollector(
 
 ```bash
 # Install StatsD dependencies
-pip install "yokedcache[monitoring]==1.0.0-beta"
+pip install "yokedcache[monitoring]==1.0.0"
 
 # Or install manually
 pip install statsd
diff --git a/site-src/pages/tutorials/fastapi-redis-caching.md b/site-src/pages/tutorials/fastapi-redis-caching.md
@@ -28,7 +28,7 @@ This comprehensive tutorial shows you how to implement high-performance caching
 Install YokedCache with full features for your FastAPI application:
 
 ```bash
-pip install "yokedcache[full]==1.0.0-beta"
+pip install "yokedcache[full]==1.0.0"
 ```
 
 This includes:
diff --git a/site-src/pages/tutorials/fastapi.md b/site-src/pages/tutorials/fastapi.md
@@ -14,7 +14,7 @@ By the end of this tutorial, you'll have a FastAPI application with:
 
 ```bash
 # Install dependencies
-pip install "yokedcache[full]==1.0.0-beta" fastapi uvicorn sqlalchemy psycopg2-binary
+pip install "yokedcache[full]==1.0.0" fastapi uvicorn sqlalchemy psycopg2-binary
 
 # Start Redis (using Docker)
 docker run -d --name redis -p 6379:6379 redis:7
@@ -63,7 +63,7 @@ class Product(Base):
 Base.metadata.create_all(bind=engine)
 
 # FastAPI app
-app = FastAPI(title="YokedCache FastAPI Tutorial", version="1.0.0-beta")
+app = FastAPI(title="YokedCache FastAPI Tutorial", version="1.0.0")
 
 # Database dependency
 def get_db():
diff --git a/site-src/pages/tutorials/sqlalchemy.md b/site-src/pages/tutorials/sqlalchemy.md
@@ -14,7 +14,7 @@ Learn how to integrate YokedCache with SQLAlchemy for high-performance database
 
 ```bash
 # Install dependencies
-pip install "yokedcache[full]==1.0.0-beta" sqlalchemy psycopg2-binary
+pip install "yokedcache[full]==1.0.0" sqlalchemy psycopg2-binary
 
 # Start Redis
 docker run -d --name redis -p 6379:6379 redis:7
diff --git a/site-src/pages/usage-patterns.md b/site-src/pages/usage-patterns.md
@@ -303,7 +303,7 @@ Find approximate matches across cached keys and optionally search within cached
 
 ```python
 # Install the fuzzy search dependencies
-# pip install "yokedcache[fuzzy]==1.0.0-beta"
+# pip install "yokedcache[fuzzy]==1.0.0"
 
 from yokedcache import YokedCache, CacheConfig
 
diff --git a/site-src/pages/vector-search.md b/site-src/pages/vector-search.md
@@ -125,7 +125,7 @@ Vector search requires additional dependencies:
 
 ```bash
 # Install vector search dependencies
-pip install "yokedcache[vector]==1.0.0-beta"
+pip install "yokedcache[vector]==1.0.0"
 
 # Or install manually
 pip install numpy scipy scikit-learn
diff --git a/site-src/static/index.html b/site-src/static/index.html
@@ -20,7 +20,7 @@
     "applicationCategory": "DeveloperApplication",
     "operatingSystem": "Linux, macOS, Windows",
     "programmingLanguage": "Python",
-    "softwareVersion": "1.0.0-beta",
+    "softwareVersion": "1.0.0",
     "offers": { "@type": "Offer", "price": "0", "priceCurrency": "USD" },
     "url": "https://sirstig.github.io/yokedcache",
     "downloadUrl": "https://pypi.org/project/yokedcache/",
@@ -72,7 +72,7 @@ <h1>Python caching built<br>for FastAPI</h1>
       </p>
       <div class="install-pill">
         <span class="prompt">$</span>
-        <span>pip install "yokedcache==1.0.0-beta"</span>
+        <span>pip install yokedcache</span>
       </div>
       <div class="hero-ctas">
         <a class="btn btn-primary" href="getting-started.html">Documentation</a>
diff --git a/site-src/static/llms.txt b/site-src/static/llms.txt
@@ -4,7 +4,7 @@
 
 ## Summary
 
-- Package: yokedcache (PyPI), current version **1.0.0-beta**
+- Package: yokedcache (PyPI), current version **1.0.0**
 - Docs: https://sirstig.github.io/yokedcache/
 - API (HTML): https://sirstig.github.io/yokedcache/api/
 - Changelog: https://sirstig.github.io/yokedcache/changelog.html
@@ -13,7 +13,7 @@
 ## Install
 
 ```
-pip install "yokedcache==1.0.0-beta"
+pip install yokedcache
 ```
 
 Extras: `yokedcache[full]` for optional backends and monitoring stacks; see PyPI metadata and getting-started guide.
diff --git a/src/yokedcache/__init__.py b/src/yokedcache/__init__.py
@@ -6,7 +6,7 @@
 database integration.
 """
 
-__version__ = "1.0.0-beta"
+__version__ = "1.0.0"
 __author__ = "SirStig"
 __email__ = "twogoodgamer2@gmail.com"
 __license__ = "MIT"
diff --git a/src/yokedcache/vector_search.py b/src/yokedcache/vector_search.py
@@ -114,7 +114,7 @@ def __init__(
         if not VECTOR_DEPS_AVAILABLE:
             raise ImportError(
                 "Vector dependencies not available. Install with: "
-                'pip install "yokedcache[vector]==1.0.0-beta"'
+                'pip install "yokedcache[vector]==1.0.0"'
             )
 
         self.similarity_method = similarity_method

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ keywords = [`
`36`	`36`	`"cache management",`
`37`	`37`	`]`
`38`	`38`	`classifiers = [`
`39`		`- "Development Status :: 4 - Beta",`
	`39`	`+ "Development Status :: 5 - Production/Stable",`
`40`	`40`	`"Intended Audience :: Developers",`
`41`	`41`	`"License :: OSI Approved :: MIT License",`
`42`	`42`	`"Operating System :: OS Independent",`