capitalize Bydantic

Author: khusmann

README.md

@@ -1,31 +1,31 @@
-# bydantic
+# Bydantic
 
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 ![PyPI - Version](https://img.shields.io/pypi/v/bydantic)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/bydantic)
 
-`bydantic` is a Python library for serializing and deserializing bitfields.
-bydantic allows you to declaratively define bitfields as Python classes with
+`Bydantic` is a Python library for serializing and deserializing bitfields.
+Bydantic allows you to declaratively define bitfields as Python classes with
 type hints, which then can be automatically serialized and deserialized to and
 from raw bytes.
 
-The name bydantic is a portmanteau of "bit" and "pydantic" -- just as
-[pydantic](https://docs.pydantic.dev) gives developers a way to declaratively
+The name Bydantic is a portmanteau of "bit" and "Pydantic" -- just as
+[Pydantic](https://docs.pydantic.dev) gives developers a way to declaratively
 define data models with type hints and then serialize and deserialize raw
-objects against those models, bydantic gives developers a way to do the same
+objects against those models, Bydantic gives developers a way to do the same
 with bitfields.
 
 ## Installation
 
-bydantic is available on PyPI and can be installed using `pip`:
+Bydantic is available on PyPI and can be installed using `pip`:
 
 ```bash
 pip install bydantic
 ```
 
 ## Quick Start
 
-Here's a simple example of how bydantic can be used:
+Here's a simple example of how Bydantic can be used:
 
 ```python
 import bydantic as bd
@@ -67,7 +67,7 @@ foo2 = Foo.from_bytes_exact(b'\x34y')
 print(foo2) # Foo(a=3, b=4, c='y')
 ```
 
-The power of bydantic, however, is that field types can be composed into complex
+The power of Bydantic, however, is that field types can be composed into complex
 data structures. For example:
 
 ```python
@@ -97,7 +97,7 @@ bar2 = Bar.from_bytes_exact(b'\x01x#y*')
 print(bar2) # Bar(d=[Foo(a=0, b=1, c='x'), Foo(a=2, b=3, c='y')], e=42)
 ```
 
-This just scratches the surface of what bydantic can do... continue reading
+This just scratches the surface of what Bydantic can do... continue reading
 [the docs](https://kylehusmann.com/bydantic/getting-started) for more info.
 
 ## Features
@@ -112,7 +112,7 @@ This just scratches the surface of what bydantic can do... continue reading
 
 ## Related Projects
 
-- [pydantic](https://docs.pydantic.dev)
+- [Pydantic](https://docs.pydantic.dev)
 
 - [bitproto](https://bitproto.readthedocs.io/)
 

docs/complex-data-structures.md

@@ -362,7 +362,7 @@ context to inform `dynamic_field` discriminators. But this is somewhat of an
 advanced feature, and not necessary to use the library.
 
 This completes our tour of the field types and combinators available in
-bydantic. Congratulations, now you can define bitfields like a pro!
+Bydantic. Congratulations, now you can define bitfields like a pro!
 
 For quick reference of field types and capabilities of the `Bitfield` class, you
 can check out the [Field Type Reference](field-type-reference.md) and

docs/getting-started.md

@@ -23,7 +23,7 @@ packet-beta
 15: "sensor_error"
 ```
 
-Without a library like bydantic, parsing this information would require manual
+Without a library like Bydantic, parsing this information would require manual
 bit manipulation and byte handling. For example, you might do something like
 this:
 
@@ -91,15 +91,15 @@ encode_weather_data(-1, 63, 7, True) # b'\xFF\xFF'
 ```
 
 This is a lot of boilerplate code to write and maintain, especially if you have
-multiple fields or more complex data structures. This is where bydantic comes
+multiple fields or more complex data structures. This is where Bydantic comes
 in.
 
-## Using bydantic
+## Using Bydantic
 
-With bydantic, we can declaratively define the structure of our protocol using
+With Bydantic, we can declaratively define the structure of our protocol using
 Python classes and type hints, and then you get serialization / deserialization
 methods for free. Here's how we would define the same weather data structure
-using bydantic:
+using Bydantic:
 
 ```python
 import bydantic as bd
@@ -164,7 +164,7 @@ WeatherPacket(
 
 As you can see, everything "just works".
 
-In addition to the field types demonstrated above, bydantic supports a variety
+In addition to the field types demonstrated above, Bydantic supports a variety
 of other primitive field types, including fields for `bytes` and `str` values.
 These field types can be composed into more complex data structures using
 combinators like `list_field`, `mapped_field`, and `dynamic_field`, which will
@@ -235,7 +235,7 @@ while True:
 
 ## Next Steps
 
-As you can see, bydantic makes it easy to define and work with binary protocols
+As you can see, Bydantic makes it easy to define and work with binary protocols
 in Python. It provides a simple and declarative way to define bitfields, and
 handles serialization and deserialization for you.
 

docs/global-context.md

@@ -138,7 +138,7 @@ this feature should probably be used sparingly. If you find yourself using a lot
 of global context, it may be a sign that you should consider making a separate
 bitfield type for each configuration.
 
-Global context is a newer feature in bydantic, so I would love to hear how you
+Global context is a newer feature in Bydantic, so I would love to hear how you
 are using it (or not using it) in your projects. If you have any feedback or
 ideas, I'd love to hear from you! You can reach me at
 [bydantic@kylehusmann.com](mailto: bydantic@kylehusmann.com).

docs/index.md

@@ -1,37 +1,37 @@
 ---
-title: Welcome to bydantic
+title: Welcome to Bydantic
 ---
 
 <!-- BEGIN CONTENT -->
 
-# bydantic
+# Bydantic
 
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 ![PyPI - Version](https://img.shields.io/pypi/v/bydantic)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/bydantic)
 
-`bydantic` is a Python library for serializing and deserializing bitfields.
-bydantic allows you to declaratively define bitfields as Python classes with
+`Bydantic` is a Python library for serializing and deserializing bitfields.
+Bydantic allows you to declaratively define bitfields as Python classes with
 type hints, which then can be automatically serialized and deserialized to and
 from raw bytes.
 
-The name bydantic is a portmanteau of "bit" and "pydantic" -- just as
-[pydantic](https://docs.pydantic.dev) gives developers a way to declaratively
+The name Bydantic is a portmanteau of "bit" and "Pydantic" -- just as
+[Pydantic](https://docs.pydantic.dev) gives developers a way to declaratively
 define data models with type hints and then serialize and deserialize raw
-objects against those models, bydantic gives developers a way to do the same
+objects against those models, Bydantic gives developers a way to do the same
 with bitfields.
 
 ## Installation
 
-bydantic is available on PyPI and can be installed using `pip`:
+Bydantic is available on PyPI and can be installed using `pip`:
 
 ```bash
 pip install bydantic
 ```
 
 ## Quick Start
 
-Here's a simple example of how bydantic can be used:
+Here's a simple example of how Bydantic can be used:
 
 ```python
 import bydantic as bd
@@ -73,7 +73,7 @@ foo2 = Foo.from_bytes_exact(b'\x34y')
 print(foo2) # Foo(a=3, b=4, c='y')
 ```
 
-The power of bydantic, however, is that field types can be composed into complex
+The power of Bydantic, however, is that field types can be composed into complex
 data structures. For example:
 
 ```python
@@ -103,7 +103,7 @@ bar2 = Bar.from_bytes_exact(b'\x01x#y*')
 print(bar2) # Bar(d=[Foo(a=0, b=1, c='x'), Foo(a=2, b=3, c='y')], e=42)
 ```
 
-This just scratches the surface of what bydantic can do... continue reading
+This just scratches the surface of what Bydantic can do... continue reading
 [the docs](https://kylehusmann.com/bydantic/getting-started) for more info.
 
 ## Features
@@ -118,7 +118,7 @@ This just scratches the surface of what bydantic can do... continue reading
 
 ## Related Projects
 
-- [pydantic](https://docs.pydantic.dev)
+- [Pydantic](https://docs.pydantic.dev)
 
 - [bitproto](https://bitproto.readthedocs.io/)
 

docs/more-field-types.md

@@ -16,7 +16,7 @@ as follows:
 | 123     | Sensor Error   | bool (1)      | Sensor error flag (1 = error)                         |
 | 124-127 | (Pad)          | uint (4)      | Padding bits, always `0`                              |
 
-With bydantic, definition can be translated into a Bitfield class that looks
+With Bydantic, definition can be translated into a Bitfield class that looks
 like this:
 
 ```python
@@ -100,10 +100,10 @@ default value in the definition to indicate the field is private and not
 necessary to provide when creating a new instance of the class.
 
 In addition to `lit_bytes_field()`, other literal field types available in
-bydantic include `lit_uint_field`, `lit_int_field`, and `lit_str_field`.
+Bydantic include `lit_uint_field`, `lit_int_field`, and `lit_str_field`.
 
 Because the size of a literal `bytes` or `str` field can be inferred from the
-literal value, bydantic allows you to omit the `lit_bytes_field()` or
+literal value, Bydantic allows you to omit the `lit_bytes_field()` or
 `lit_str_field()` call and simply use the value itself. So the following is
 equivalent to the above definition of `_header`:
 
@@ -172,7 +172,7 @@ class ValueMapper(t.Protocol[T, P]):
         ...
 ```
 
-Here, we're using `Scale`, a built-in `ValueMapper` defined in bydantic as
+Here, we're using `Scale`, a built-in `ValueMapper` defined in Bydantic as
 follows:
 
 ```python