docs: update documentation for project rename to msgspec-x

Author: nightsailer

docs/source/_templates/help.html

@@ -1,5 +1,5 @@
 <h3>Need help?</h3>
 
 <p>
-  Open an issue in the <a href="https://github.com/jcrist/msgspec/issues">issue tracker</a>.
-</p>
+  Open an issue in the <a href="https://github.com/nightsailer/msgspec-x/issues">issue tracker</a>.
+</p>

docs/source/benchmarks.rst

@@ -2,6 +2,7 @@ Benchmarks
 ==========
 
 .. note::
+   These benchmarks are for ``msgspec-x``, a community-driven fork of the original msgspec project.
 
     Benchmarks are *hard*.
 

docs/source/converters.rst

@@ -127,9 +127,9 @@ support by wrapping the standard library's `tomllib` module as follows:
 ``msgspec`` uses these APIs to implement ``toml`` and ``yaml`` support,
 wrapping external serialization libraries:
 
-- ``msgspec.toml`` (`code <https://github.com/jcrist/msgspec/blob/main/msgspec/toml.py>`__)
+- ``msgspec.toml`` (`code <https://github.com/nightsailer/msgspec-x/blob/main/msgspec/toml.py>`__)
 
-- ``msgspec.yaml`` (`code <https://github.com/jcrist/msgspec/blob/main/msgspec/yaml.py>`__)
+- ``msgspec.yaml`` (`code <https://github.com/nightsailer/msgspec-x/blob/main/msgspec/yaml.py>`__)
 
 The implementation in ``msgspec.toml`` is *almost* identical to the one above,
 with some additional code for error handling.

docs/source/examples/geojson.rst

@@ -21,7 +21,7 @@ types, and :ref:`struct-tagged-unions` to differentiate between them. See the
 relevant docs for more information.
 
 The full example source can be found `here
-<https://github.com/jcrist/msgspec/blob/main/examples/geojson>`__.
+<https://github.com/nightsailer/msgspec-x/blob/main/examples/geojson>`__.
 
 .. literalinclude:: ../../../examples/geojson/msgspec_geojson.py
     :language: python

docs/source/examples/pyproject-toml.rst

@@ -23,7 +23,7 @@ file. This includes full schema definitions for all fields in the
 ``tool``.
 
 The full example source can be found `here
-<https://github.com/jcrist/msgspec/blob/main/examples/pyproject-toml>`__.
+<https://github.com/nightsailer/msgspec-x/blob/main/examples/pyproject-toml>`__.
 
 .. literalinclude:: ../../../examples/pyproject-toml/pyproject.py
     :language: python

docs/source/index.rst

@@ -1,7 +1,13 @@
-msgspec
+msgspec-x
 =======
 
-``msgspec`` is a *fast* serialization and validation library, with builtin
+``msgspec-x`` is a community-driven fork of the original msgspec library. It provides two namespaces:
+- ``msgspec``: 100% compatible with the original API for drop-in replacement.
+- ``msgspec_x``: Extended features and community contributions.
+
+Do not install both ``msgspec`` and ``msgspec-x`` in the same environment.
+
+``msgspec-x`` is a *fast* serialization and validation library, with builtin
 support for JSON_, MessagePack_, YAML_, and TOML_. It features:
 
 - 🚀 **High performance encoders/decoders** for common protocols. The JSON and
@@ -12,7 +18,7 @@ support for JSON_, MessagePack_, YAML_, and TOML_. It features:
   be supported through :doc:`extensions <extending>`.
 
 - 🔍 **Zero-cost schema validation** using familiar Python type annotations.
-  In :doc:`benchmarks <benchmarks>` ``msgspec`` decodes *and* validates JSON
+  In :doc:`benchmarks <benchmarks>` ``msgspec-x`` decodes *and* validates JSON
   faster than orjson_ can decode it alone.
 
 - ✨ **A speedy Struct type** for representing structured data. If you already
@@ -24,9 +30,9 @@ All of this is included in a :ref:`lightweight library
 
 -----
 
-``msgspec`` may be used for serialization alone, as a faster JSON or
+``msgspec-x`` may be used for serialization alone, as a faster JSON or
 MessagePack library. For the greatest benefit though, we recommend using
-``msgspec`` to handle the full serialization & validation workflow:
+``msgspec-x`` to handle the full serialization & validation workflow:
 
 **Define** your message schemas using standard Python type annotations.
 
@@ -66,40 +72,40 @@ MessagePack library. For the greatest benefit though, we recommend using
       File "<stdin>", line 1, in <module>
     msgspec.ValidationError: Expected `str`, got `int` - at `$.groups[0]`
 
-``msgspec`` is designed to be as performant as possible, while retaining some
+``msgspec-x`` is designed to be as performant as possible, while retaining some
 of the nicities of validation libraries like pydantic_. For supported types,
-encoding/decoding a message with ``msgspec`` can be :doc:`~10-80x faster than
+encoding/decoding a message with ``msgspec-x`` can be :doc:`~10-80x faster than
 alternative libraries <benchmarks>`.
 
 Highlights
 ----------
 
-- ``msgspec`` is **fast**. It :doc:`benchmarks <benchmarks>` as the fastest
+- ``msgspec-x`` is **fast**. It :doc:`benchmarks <benchmarks>` as the fastest
   serialization library for Python, outperforming all other JSON/MessagePack
   libraries compared.
 
-- ``msgspec`` is **friendly**. Through use of Python's type annotations,
+- ``msgspec-x`` is **friendly**. Through use of Python's type annotations,
   messages are :ref:`validated <typed-decoding>` during deserialization in a
-  declarative way. ``msgspec`` also works well with other type-checking tooling
+  declarative way. ``msgspec-x`` also works well with other type-checking tooling
   like mypy_ and pyright_, providing excellent editor integration.
 
-- ``msgspec`` is **flexible**. It natively supports a :doc:`wide range of
+- ``msgspec-x`` is **flexible**. It natively supports a :doc:`wide range of
   Python builtin types <supported-types>`. Support for additional types can
   also be added through :doc:`extensions <extending>`.
 
-- ``msgspec`` is **lightweight**. It has no required dependencies, and the
+- ``msgspec-x`` is **lightweight**. It has no required dependencies, and the
   binary size is :ref:`a fraction of that of comparable libraries
   <benchmark-library-size>`.
 
-- ``msgspec`` is **correct**. The encoders/decoders implemented are strictly
+- ``msgspec-x`` is **correct**. The encoders/decoders implemented are strictly
   compliant with their respective specifications, providing stronger guarantees
   of compatibility with other systems.
 
 Used By
 -------
 
-``msgspec`` is used by many organizations and `open source projects
-<https://github.com/jcrist/msgspec/network/dependents>`__, here we highlight a
+``msgspec-x`` is used by many organizations and `open source projects
+<https://github.com/nightsailer/msgspec-x/network/dependents>`__, here we highlight a
 few:
 
 .. grid:: 2 2 4 4

docs/source/inspect.rst

@@ -142,7 +142,7 @@ subclass. See the :ref:`API docs <inspect-api>` for a complete list of types.
 For an example of using these functions, you might find our builtin
 :doc:`jsonschema` generator implementation useful - the code for this can be
 found `here
-<https://github.com/jcrist/msgspec/blob/main/msgspec/_json_schema.py>`__. In
+<https://github.com/nightsailer/msgspec-x/blob/main/msgspec/_json_schema.py>`__. In
 particular, take a look at the large if-else statement in ``_to_schema``.
 
 

docs/source/install.rst

@@ -1,26 +1,28 @@
 Installation
 ============
 
-``msgspec`` may be installed via ``pip`` or ``conda``. Note that Python >= 3.8
-is required. The basic install has no required dependencies.
+``msgspec-x`` may be installed via ``pip`` or ``conda``. Note that Python >= 3.9 is required. The basic install has no required dependencies.
 
 **pip**
 
 .. code-block:: shell
 
-    pip install msgspec
+    pip install msgspec-x
 
 **conda**
 
 .. code-block:: shell
 
-    conda install msgspec -c conda-forge
+    conda install msgspec-x -c conda-forge
+
+.. note::
+   Do not install both ``msgspec`` and ``msgspec-x`` in the same environment.
 
 
 Optional Dependencies
 ---------------------
 
-Depending on your platform, the base install of ``msgspec`` may not support
+Depending on your platform, the base install of ``msgspec-x`` may not support
 TOML_ or YAML_ without additional dependencies.
 
 TOML
@@ -40,13 +42,13 @@ extra:
 
 .. code-block:: shell
 
-    pip install "msgspec[toml]"
+    pip install "msgspec-x[toml]"
 
 **conda**
 
 .. code-block:: shell
 
-    conda install msgspec-toml -c conda-forge
+    conda install msgspec-x-toml -c conda-forge
 
 YAML
 ~~~~
@@ -58,13 +60,13 @@ this dependency manually, or depend on the ``yaml`` extra:
 
 .. code-block:: shell
 
-    pip install "msgspec[yaml]"
+    pip install "msgspec-x[yaml]"
 
 **conda**
 
 .. code-block:: shell
 
-    conda install msgspec-yaml -c conda-forge
+    conda install msgspec-x-yaml -c conda-forge
 
 
 Installing from GitHub

docs/source/supported-types.rst

@@ -1616,5 +1616,9 @@ TOML_ types are decoded to Python types as follows:
 .. _pyright: https://github.com/microsoft/pyright
 .. _generic types:
 .. _user-defined generic types: https://docs.python.org/3/library/typing.html#user-defined-generic-types
-.. _open an issue: https://github.com/jcrist/msgspec/issues>
+.. _open an issue: https://github.com/nightsailer/msgspec-x/issues>
 .. _ISO 8601 duration strings: https://en.wikipedia.org/wiki/ISO_8601#Durations
+
+- ``msgspec`` is used by many organizations and `open source projects
+  <https://github.com/nightsailer/msgspec-x/network/dependents>`__, here we highlight a
+  few:

msgspec_x/__init__.py

@@ -0,0 +1,10 @@
+"""
+msgspec_x - Extended features for msgspec
+
+This namespace provides additional functionality and community contributions
+that extend the original msgspec library capabilities.
+
+
+For compatibility with existing code, use the `msgspec` namespace.
+For new extended features, use this `msgspec_x` namespace.
+"""