Dm/beta

CHANGELOG.md

@@ -1,11 +1,16 @@
 # Changelog
+
 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.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.1.0] - 2024-12-09
+
+- `rfc3161-client` is now in beta ([XX](https://github.com/trailofbits/rfc3161-client/pull/XX)).
+
 ## [0.0.5] - 2024-12-02
 
 ### Changed
@@ -32,13 +37,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - The CI now correctly builds wheels for Windows
   ([49](https://github.com/trailofbits/rfc3161-client/pull/49))
 
-
 ## [0.0.2] - 2024-10-30
 
 ### Added
 
-- Magic methods (`__hash__` and `__repr__`) have been added for TimestampResponse and
-  TimestampRequest ([#32](https://github.com/trailofbits/rfc3161-client/pull/32))
+- Magic methods (`__hash__` and `__repr__`) have been added for
+  TimestampResponse and TimestampRequest ([#32](https://github.com/trailofbits/rfc3161-client/pull/32))
 - `VerifierBuilder` is now the only way to create a `Verifier` ([#35](https://github.com/trailofbits/rfc3161-client/pull/35))
 
 ### Fixed
@@ -56,7 +60,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 This is the first alpha release of `rfc3161-client`.
 
-[Unreleased]: https://github.com/trailofbits/rfc3161-client/compare/v0.0.5...HEAD
+[Unreleased]: https://github.com/trailofbits/rfc3161-client/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/trailofbits/rfc3161-client/compare/v0.0.5...v0.1.0
 [0.0.4]: https://github.com/trailofbits/rfc3161-client/compare/v0.0.4...v0.0.5
 [0.0.4]: https://github.com/trailofbits/rfc3161-client/compare/v0.0.3...v0.0.4
 [0.0.3]: https://github.com/trailofbits/rfc3161-client/compare/v0.0.2...v0.0.3

README.md

@@ -1,37 +1,41 @@
 # `rfc3161-client`
 
-> [!WARNING]  
-> This project is an alpha version and should not be used in production.
+> [!WARNING]
+> This project is currently in beta. While it is already being used in
+> production by downstream projects, we reserve the right to make breaking
+> changes to the API. We recommend pinning to specific versions until we reach
+> a stable 1.0 release.
 
 
 `rfc3161-client` is a Python library implementing the Time-Stamp Protocol (TSP)
 described in [RFC 3161](https://www.ietf.org/rfc/rfc3161.txt).
 
 It is composed of three subprojects:
 
-- [:crab: tsp-asn1](./rust/tsp-asn1/Cargo.toml): A Rust crate using [`rust-asn1`](https://docs.rs/asn1/latest/asn1/index.html)
-  to create the types used by the Time-Stamp protocol. This crate depends on 
-  rust-asn1 and cryptography to minimize the amount of duplicated code. While 
-  it is usable as a standalone crate, this is not officially supported. Drop 
+- [:crab: tsp-asn1](./rust/tsp-asn1/Cargo.toml): A Rust crate using 
+  [`rust-asn1`](https://docs.rs/asn1/latest/asn1/index.html) to create the 
+  types used by the Time-Stamp protocol. This crate depends on `rust-asn1` 
+  and `cryptography` to minimize the amount of duplicated code. While
+  it is usable as a standalone crate, this is not officially supported. Drop
   us a message if you are interested in using it.
-- [:crab: rfc3161-client](./rust/Cargo.toml): Another Rust crate that 
-  provides 
-  Python bindings to the `tsp-asn1` crate using PyO3. 
-- [:snake: rfc3161-client](./pyproject.toml) A Python library using the 
-  crate above to provide an usable API to create Timestamp Request and read 
-  Timestamp Response. 
+- [:crab: rfc3161-client](./rust/Cargo.toml): Another Rust crate that
+  provides Python bindings to the `tsp-asn1` crate using PyO3.
+- [:snake: rfc3161-client](./pyproject.toml) A Python library using the
+  crate above to provide a usable API to create Timestamp Request and read
+  Timestamp Response.
 
 # Goals and anti-goals
 
-- This library should be correct and provide an accurate implementation of 
-protocol described in the RFC 3161.
-- This library does not perform any network activity, it simply provides 
-  primitive to build and verify objects. Network activity must be handled 
+- This library should be correct and provide an accurate implementation of
+  protocol described in the RFC 3161.
+- This library does not perform any network activity, it simply provides
+  primitive to build and verify objects. Network activity must be handled
   separately.
 
 # License
 
 Apache 2.0
 
 # Authors
-Trail of Bits
+
+Trail of Bits

pyproject.toml

@@ -2,7 +2,7 @@
 name = "rfc3161-client"
 requires-python = ">=3.9"
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
     "Programming Language :: Rust",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: Implementation :: CPython",