Metadata-Version: 2.1
Name: checksum_dict
Version: 2.1.10.dev0
Summary: checksum_dict's objects handle the simple but repetitive task of checksumming addresses before setting/getting dictionary values.
Home-page: https://github.com/BobTheBuidler/checksum_dict
Author: BobTheBuidler
Author-email: bobthebuidlerdefi@gmail.com
License: MIT
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cchecksum>=0.0.3
Requires-Dist: mypy-extensions>=0.4.2

## checksum_dict
checksum_dict's objects handle the simple but repetitive task of checksumming addresses before setting/getting dictionary values.

### Installation
`pip install checksum_dict`

---
### Usage
There are only two things you must know...

##### ChecksumAddressDict
```
from checksum_dict import ChecksumAddressDict

d = ChecksumAddressDict()
lower = "0xb47e3cd837ddf8e4c57f05d70ab865de6e193bbb"
d[lower] = True
print(d)
>>> ChecksumAddressDict({'0xb47e3cd837dDF8e4c57F05d70Ab865de6e193BBB': True})
print(d[lower])
>>> True
```
As you can see, the lowercase key `lower` was checksummed and both the key and value were added to the dict as you would expect.

##### DefaultChecksumDict
We also have a checksummed version of a defaultdict:
```
from checksum_dict import DefaultChecksumDict

default = int
d = DefaultChecksumDict(default)
print(d[lower])
>>> 0
```
Although the key was not found in the dictionary, the `default`, in this case `int`, was called and returned a 0, just like with a traditional defaultdict!

---
### Summary
Okay, now that's about it. I hope you all get immense value from this simple yet powerful tool. Now get out there and let's do some buidling!
