byteforge-crypto-commons 0.1__tar.gz

byteforge_crypto_commons-0.1/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+*.pyc
+*.sqlite
+lib
+bin
+pyvenv.cfg
+.vscode
+main.py
+build_publish.sh
+dist

byteforge_crypto_commons-0.1/LICENSE

@@ -0,0 +1,201 @@
+                             Apache License
+                       Version 2.0, January 2004
+                    http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+  "Licensor" shall mean the copyright owner or entity authorized by
+  the copyright owner that is granting the License.
+
+  "Legal Entity" shall mean the union of the acting entity and all
+  other entities that control, are controlled by, or are under common
+  control with that entity. For the purposes of this definition,
+  "control" means (i) the power, direct or indirect, to cause the
+  direction or management of such entity, whether by contract or
+  otherwise, or (ii) ownership of fifty percent (50%) or more of the
+  outstanding shares, or (iii) beneficial ownership of such entity.
+
+  "You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.
+
+  "Source" form shall mean the preferred form for making modifications,
+  including but not limited to software source code, documentation
+  source, and configuration files.
+
+  "Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but
+  not limited to compiled object code, generated documentation,
+  and conversions to other media types.
+
+  "Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work
+  (an example is provided in the Appendix below).
+
+  "Derivative Works" shall mean any work, whether in Source or Object
+  form, that is based on (or derived from) the Work and for which the
+  editorial revisions, annotations, elaborations, or other modifications
+  represent, as a whole, an original work of authorship. For the purposes
+  of this License, Derivative Works shall not include works that remain
+  separable from, or merely link (or bind by name) to the interfaces of,
+  the Work and Derivative Works thereof.
+
+  "Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or additions
+  to that Work or Derivative Works thereof, that is intentionally
+  submitted to Licensor for inclusion in the Work by the copyright owner
+  or by an individual or Legal Entity authorized to submit on behalf of
+  the copyright owner. For the purposes of this definition, "submitted"
+  means any form of electronic, verbal, or written communication sent
+  to the Licensor or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control systems,
+  and issue tracking systems that are managed by, or on behalf of, the
+  Licensor for the purpose of discussing and improving the Work, but
+  excluding communication that is conspicuously marked or otherwise
+  designated in writing by the copyright owner as "Not a Contribution."
+
+  "Contributor" shall mean Licensor and any individual or Legal Entity
+  on behalf of whom a Contribution has been received by Licensor and
+  subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  copyright license to reproduce, prepare Derivative Works of,
+  publicly display, publicly perform, sublicense, and distribute the
+  Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have made,
+  use, offer to sell, sell, import, and otherwise transfer the Work,
+  where such license applies only to those patent claims licensable
+  by such Contributor that are necessarily infringed by their
+  Contribution(s) alone or by combination of their Contribution(s)
+  with the Work to which such Contribution(s) was submitted. If You
+  institute patent litigation against any entity (including a
+  cross-claim or counterclaim in a lawsuit) alleging that the Work
+  or a Contribution incorporated within the Work constitutes direct
+  or contributory patent infringement, then any patent licenses
+  granted to You under this License for that Work shall terminate
+  as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+  Work or Derivative Works thereof in any medium, with or without
+  modifications, and in Source or Object form, provided that You
+  meet the following conditions:
+
+  (a) You must give any other recipients of the Work or
+      Derivative Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+  You may add Your own copyright statement to Your modifications and
+  may provide additional or different license terms and conditions
+  for use, reproduction, or distribution of Your modifications, or
+  for any such Derivative Works as a whole, provided Your use,
+  reproduction, and distribution of the Work otherwise complies with
+  the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+  any Contribution intentionally submitted for inclusion in the Work
+  by You to the Licensor shall be under the terms and conditions of
+  this License, without any additional terms or conditions.
+  Notwithstanding the above, nothing herein shall supersede or modify
+  the terms of any separate license agreement you may have executed
+  with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+  names, trademarks, service marks, or product names of the Licensor,
+  except as required for reasonable and customary use in describing the
+  origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+  Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or conditions
+  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+  PARTICULAR PURPOSE. You are solely responsible for determining the
+  appropriateness of using or redistributing the Work and assume any
+  risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+  negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect, special,
+  incidental, or consequential damages of any character arising as a
+  result of this License or out of the use or inability to use the
+  Work (including but not limited to damages for loss of goodwill,
+  work stoppage, computer failure or malfunction, or any and all
+  other commercial damages or losses), even if such Contributor
+  has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+  the Work or Derivative Works thereof, You may choose to offer,
+  and charge a fee for, acceptance of support, warranty, indemnity,
+  or other liability obligations and/or rights consistent with this
+  License. However, in accepting such obligations, You may act only
+  on Your own behalf and on Your sole responsibility, not on behalf
+  of any other Contributor, and only if You agree to indemnify,
+  defend, and hold each Contributor harmless for any liability
+  incurred by, or claims asserted against, such Contributor by reason
+  of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+  To apply the Apache License to your work, attach the following
+  boilerplate notice, with the fields enclosed by brackets "{}"
+  replaced with your own identifying information. (Don't include
+  the brackets!)  The text should be enclosed in the appropriate
+  comment syntax for the file format. We also recommend that a
+  file or class name and description of purpose be included on the
+  same "printed page" as the copyright notice for easier
+  identification within third-party archives.
+
+Copyright 2014-2017 Martin Simon
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

byteforge_crypto_commons-0.1/PKG-INFO

@@ -0,0 +1,330 @@
+Metadata-Version: 2.4
+Name: byteforge-crypto-commons
+Version: 0.1
+Summary: Common models and dependencies for crypto projects.
+Project-URL: Homepage, https://github.com/jmazzahacks/byteforge-crypto-commons
+Project-URL: Issues, https://github.com/jmazzahacks/byteforge-crypto-commons/issues
+Author: Jason Byteforge
+License:                              Apache License
+                               Version 2.0, January 2004
+                            http://www.apache.org/licenses/
+        
+        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+        1. Definitions.
+        
+          "License" shall mean the terms and conditions for use, reproduction,
+          and distribution as defined by Sections 1 through 9 of this document.
+        
+          "Licensor" shall mean the copyright owner or entity authorized by
+          the copyright owner that is granting the License.
+        
+          "Legal Entity" shall mean the union of the acting entity and all
+          other entities that control, are controlled by, or are under common
+          control with that entity. For the purposes of this definition,
+          "control" means (i) the power, direct or indirect, to cause the
+          direction or management of such entity, whether by contract or
+          otherwise, or (ii) ownership of fifty percent (50%) or more of the
+          outstanding shares, or (iii) beneficial ownership of such entity.
+        
+          "You" (or "Your") shall mean an individual or Legal Entity
+          exercising permissions granted by this License.
+        
+          "Source" form shall mean the preferred form for making modifications,
+          including but not limited to software source code, documentation
+          source, and configuration files.
+        
+          "Object" form shall mean any form resulting from mechanical
+          transformation or translation of a Source form, including but
+          not limited to compiled object code, generated documentation,
+          and conversions to other media types.
+        
+          "Work" shall mean the work of authorship, whether in Source or
+          Object form, made available under the License, as indicated by a
+          copyright notice that is included in or attached to the work
+          (an example is provided in the Appendix below).
+        
+          "Derivative Works" shall mean any work, whether in Source or Object
+          form, that is based on (or derived from) the Work and for which the
+          editorial revisions, annotations, elaborations, or other modifications
+          represent, as a whole, an original work of authorship. For the purposes
+          of this License, Derivative Works shall not include works that remain
+          separable from, or merely link (or bind by name) to the interfaces of,
+          the Work and Derivative Works thereof.
+        
+          "Contribution" shall mean any work of authorship, including
+          the original version of the Work and any modifications or additions
+          to that Work or Derivative Works thereof, that is intentionally
+          submitted to Licensor for inclusion in the Work by the copyright owner
+          or by an individual or Legal Entity authorized to submit on behalf of
+          the copyright owner. For the purposes of this definition, "submitted"
+          means any form of electronic, verbal, or written communication sent
+          to the Licensor or its representatives, including but not limited to
+          communication on electronic mailing lists, source code control systems,
+          and issue tracking systems that are managed by, or on behalf of, the
+          Licensor for the purpose of discussing and improving the Work, but
+          excluding communication that is conspicuously marked or otherwise
+          designated in writing by the copyright owner as "Not a Contribution."
+        
+          "Contributor" shall mean Licensor and any individual or Legal Entity
+          on behalf of whom a Contribution has been received by Licensor and
+          subsequently incorporated within the Work.
+        
+        2. Grant of Copyright License. Subject to the terms and conditions of
+          this License, each Contributor hereby grants to You a perpetual,
+          worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+          copyright license to reproduce, prepare Derivative Works of,
+          publicly display, publicly perform, sublicense, and distribute the
+          Work and such Derivative Works in Source or Object form.
+        
+        3. Grant of Patent License. Subject to the terms and conditions of
+          this License, each Contributor hereby grants to You a perpetual,
+          worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+          (except as stated in this section) patent license to make, have made,
+          use, offer to sell, sell, import, and otherwise transfer the Work,
+          where such license applies only to those patent claims licensable
+          by such Contributor that are necessarily infringed by their
+          Contribution(s) alone or by combination of their Contribution(s)
+          with the Work to which such Contribution(s) was submitted. If You
+          institute patent litigation against any entity (including a
+          cross-claim or counterclaim in a lawsuit) alleging that the Work
+          or a Contribution incorporated within the Work constitutes direct
+          or contributory patent infringement, then any patent licenses
+          granted to You under this License for that Work shall terminate
+          as of the date such litigation is filed.
+        
+        4. Redistribution. You may reproduce and distribute copies of the
+          Work or Derivative Works thereof in any medium, with or without
+          modifications, and in Source or Object form, provided that You
+          meet the following conditions:
+        
+          (a) You must give any other recipients of the Work or
+              Derivative Works a copy of this License; and
+        
+          (b) You must cause any modified files to carry prominent notices
+              stating that You changed the files; and
+        
+          (c) You must retain, in the Source form of any Derivative Works
+              that You distribute, all copyright, patent, trademark, and
+              attribution notices from the Source form of the Work,
+              excluding those notices that do not pertain to any part of
+              the Derivative Works; and
+        
+          (d) If the Work includes a "NOTICE" text file as part of its
+              distribution, then any Derivative Works that You distribute must
+              include a readable copy of the attribution notices contained
+              within such NOTICE file, excluding those notices that do not
+              pertain to any part of the Derivative Works, in at least one
+              of the following places: within a NOTICE text file distributed
+              as part of the Derivative Works; within the Source form or
+              documentation, if provided along with the Derivative Works; or,
+              within a display generated by the Derivative Works, if and
+              wherever such third-party notices normally appear. The contents
+              of the NOTICE file are for informational purposes only and
+              do not modify the License. You may add Your own attribution
+              notices within Derivative Works that You distribute, alongside
+              or as an addendum to the NOTICE text from the Work, provided
+              that such additional attribution notices cannot be construed
+              as modifying the License.
+        
+          You may add Your own copyright statement to Your modifications and
+          may provide additional or different license terms and conditions
+          for use, reproduction, or distribution of Your modifications, or
+          for any such Derivative Works as a whole, provided Your use,
+          reproduction, and distribution of the Work otherwise complies with
+          the conditions stated in this License.
+        
+        5. Submission of Contributions. Unless You explicitly state otherwise,
+          any Contribution intentionally submitted for inclusion in the Work
+          by You to the Licensor shall be under the terms and conditions of
+          this License, without any additional terms or conditions.
+          Notwithstanding the above, nothing herein shall supersede or modify
+          the terms of any separate license agreement you may have executed
+          with Licensor regarding such Contributions.
+        
+        6. Trademarks. This License does not grant permission to use the trade
+          names, trademarks, service marks, or product names of the Licensor,
+          except as required for reasonable and customary use in describing the
+          origin of the Work and reproducing the content of the NOTICE file.
+        
+        7. Disclaimer of Warranty. Unless required by applicable law or
+          agreed to in writing, Licensor provides the Work (and each
+          Contributor provides its Contributions) on an "AS IS" BASIS,
+          WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+          implied, including, without limitation, any warranties or conditions
+          of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+          PARTICULAR PURPOSE. You are solely responsible for determining the
+          appropriateness of using or redistributing the Work and assume any
+          risks associated with Your exercise of permissions under this License.
+        
+        8. Limitation of Liability. In no event and under no legal theory,
+          whether in tort (including negligence), contract, or otherwise,
+          unless required by applicable law (such as deliberate and grossly
+          negligent acts) or agreed to in writing, shall any Contributor be
+          liable to You for damages, including any direct, indirect, special,
+          incidental, or consequential damages of any character arising as a
+          result of this License or out of the use or inability to use the
+          Work (including but not limited to damages for loss of goodwill,
+          work stoppage, computer failure or malfunction, or any and all
+          other commercial damages or losses), even if such Contributor
+          has been advised of the possibility of such damages.
+        
+        9. Accepting Warranty or Additional Liability. While redistributing
+          the Work or Derivative Works thereof, You may choose to offer,
+          and charge a fee for, acceptance of support, warranty, indemnity,
+          or other liability obligations and/or rights consistent with this
+          License. However, in accepting such obligations, You may act only
+          on Your own behalf and on Your sole responsibility, not on behalf
+          of any other Contributor, and only if You agree to indemnify,
+          defend, and hold each Contributor harmless for any liability
+          incurred by, or claims asserted against, such Contributor by reason
+          of your accepting any such warranty or additional liability.
+        
+        END OF TERMS AND CONDITIONS
+        
+        APPENDIX: How to apply the Apache License to your work.
+        
+          To apply the Apache License to your work, attach the following
+          boilerplate notice, with the fields enclosed by brackets "{}"
+          replaced with your own identifying information. (Don't include
+          the brackets!)  The text should be enclosed in the appropriate
+          comment syntax for the file format. We also recommend that a
+          file or class name and description of purpose be included on the
+          same "printed page" as the copyright notice for easier
+          identification within third-party archives.
+        
+        Copyright 2014-2017 Martin Simon
+        
+        Licensed under the Apache License, Version 2.0 (the "License");
+        you may not use this file except in compliance with the License.
+        You may obtain a copy of the License at
+        
+           http://www.apache.org/licenses/LICENSE-2.0
+        
+        Unless required by applicable law or agreed to in writing, software
+        distributed under the License is distributed on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+        See the License for the specific language governing permissions and
+        limitations under the License.
+License-File: LICENSE
+Keywords: API,byteforge,byteforge-coinmarketcap,cryptocurrency,crytpo
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: python-dateutil
+Description-Content-Type: text/markdown
+
+# ByteForge Crypto Commons
+
+A Python library providing common models and utilities for cryptocurrency projects. This library serves as a foundation for building cryptocurrency-related applications by providing standardized data models and types.
+
+## Features
+
+- **Standardized Data Models**: Well-defined Python dataclasses for representing cryptocurrency data
+- **Type Safety**: Full type hints and documentation for all models
+- **Comprehensive Market Data**: Support for various market metrics and statistics
+- **Flexible Design**: Optional fields for extended data while maintaining core required fields
+
+## Installation
+
+```bash
+pip install byteforge-crypto-commons
+```
+
+## Usage
+
+### Token State
+
+The `TokenState` class represents the complete state of a cryptocurrency token at a specific moment in time:
+
+```python
+from crypto_commons.types.token_state import TokenState
+from crypto_commons.types.quote import Quote
+import datetime
+
+# Create a quote for USD
+quote = Quote(
+    base_currency="USD",
+    price=50000.0,
+    volume_24h=1000000000.0,
+    percent_change_1h=1.5,
+    percent_change_24h=5.0,
+    percent_change_7d=10.0,
+    percent_change_30d=20.0,
+    market_cap=1000000000000.0,
+    last_updated=datetime.datetime.now()
+)
+
+# Create a token state
+token_state = TokenState(
+    id=1,
+    name="Bitcoin",
+    symbol="BTC",
+    timestamp=int(datetime.datetime.now().timestamp()),
+    quote_map={"USD": quote}
+)
+```
+
+### Quote
+
+The `Quote` class represents market data for a cryptocurrency in a specific currency:
+
+```python
+from crypto_commons.types.quote import Quote
+import datetime
+
+quote = Quote(
+    base_currency="USD",
+    price=50000.0,
+    volume_24h=1000000000.0,
+    percent_change_1h=1.5,
+    percent_change_24h=5.0,
+    percent_change_7d=10.0,
+    percent_change_30d=20.0,
+    market_cap=1000000000000.0,
+    last_updated=datetime.datetime.now()
+)
+```
+
+## Data Models
+
+### TokenState
+
+Represents the complete state of a cryptocurrency token, including:
+- Basic information (id, name, symbol)
+- Market data through Quote objects
+- Supply metrics (circulating, total, max supply)
+- Status indicators (is_active, is_fiat)
+- Additional metadata (tags, platform, creation date)
+
+### Quote
+
+Represents market data for a cryptocurrency in a specific currency, including:
+- Price and volume data
+- Market capitalization
+- Percentage changes over various time periods
+- Supply metrics
+- Additional market statistics
+
+## Requirements
+
+- Python 3.8 or higher
+- python-dateutil
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Author
+
+- Jason Byteforge
+
+## Project Links
+
+- [GitHub Repository](https://github.com/jmazzahacks/byteforge-crypto-commons)
+- [Issue Tracker](https://github.com/jmazzahacks/byteforge-crypto-commons/issues) 

byteforge_crypto_commons-0.1/README.md

@@ -0,0 +1,113 @@
+# ByteForge Crypto Commons
+
+A Python library providing common models and utilities for cryptocurrency projects. This library serves as a foundation for building cryptocurrency-related applications by providing standardized data models and types.
+
+## Features
+
+- **Standardized Data Models**: Well-defined Python dataclasses for representing cryptocurrency data
+- **Type Safety**: Full type hints and documentation for all models
+- **Comprehensive Market Data**: Support for various market metrics and statistics
+- **Flexible Design**: Optional fields for extended data while maintaining core required fields
+
+## Installation
+
+```bash
+pip install byteforge-crypto-commons
+```
+
+## Usage
+
+### Token State
+
+The `TokenState` class represents the complete state of a cryptocurrency token at a specific moment in time:
+
+```python
+from crypto_commons.types.token_state import TokenState
+from crypto_commons.types.quote import Quote
+import datetime
+
+# Create a quote for USD
+quote = Quote(
+    base_currency="USD",
+    price=50000.0,
+    volume_24h=1000000000.0,
+    percent_change_1h=1.5,
+    percent_change_24h=5.0,
+    percent_change_7d=10.0,
+    percent_change_30d=20.0,
+    market_cap=1000000000000.0,
+    last_updated=datetime.datetime.now()
+)
+
+# Create a token state
+token_state = TokenState(
+    id=1,
+    name="Bitcoin",
+    symbol="BTC",
+    timestamp=int(datetime.datetime.now().timestamp()),
+    quote_map={"USD": quote}
+)
+```
+
+### Quote
+
+The `Quote` class represents market data for a cryptocurrency in a specific currency:
+
+```python
+from crypto_commons.types.quote import Quote
+import datetime
+
+quote = Quote(
+    base_currency="USD",
+    price=50000.0,
+    volume_24h=1000000000.0,
+    percent_change_1h=1.5,
+    percent_change_24h=5.0,
+    percent_change_7d=10.0,
+    percent_change_30d=20.0,
+    market_cap=1000000000000.0,
+    last_updated=datetime.datetime.now()
+)
+```
+
+## Data Models
+
+### TokenState
+
+Represents the complete state of a cryptocurrency token, including:
+- Basic information (id, name, symbol)
+- Market data through Quote objects
+- Supply metrics (circulating, total, max supply)
+- Status indicators (is_active, is_fiat)
+- Additional metadata (tags, platform, creation date)
+
+### Quote
+
+Represents market data for a cryptocurrency in a specific currency, including:
+- Price and volume data
+- Market capitalization
+- Percentage changes over various time periods
+- Supply metrics
+- Additional market statistics
+
+## Requirements
+
+- Python 3.8 or higher
+- python-dateutil
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Author
+
+- Jason Byteforge
+
+## Project Links
+
+- [GitHub Repository](https://github.com/jmazzahacks/byteforge-crypto-commons)
+- [Issue Tracker](https://github.com/jmazzahacks/byteforge-crypto-commons/issues) 

byteforge_crypto_commons-0.1/crypto_commons/types/quote.py

@@ -0,0 +1,62 @@
+from dataclasses import dataclass
+from typing import Optional
+import datetime
+
+@dataclass
+class Quote:
+    """Represents a cryptocurrency quote with market data and statistics.
+    
+    This class encapsulates all relevant market data for a cryptocurrency, including
+    price, volume, market cap, and various percentage changes over different time periods.
+    It's designed to handle both required core metrics and optional extended metrics.
+    
+    Attributes:
+        base_currency (str): The cryptocurrency symbol (e.g., 'BTC', 'ETH').
+        price (float): Current price of the cryptocurrency.
+        volume_24h (float): 24-hour trading volume in the base currency.
+        percent_change_1h (float): Price change percentage over the last hour.
+        percent_change_24h (float): Price change percentage over the last 24 hours.
+        percent_change_7d (float): Price change percentage over the last 7 days.
+        percent_change_30d (float): Price change percentage over the last 30 days.
+        market_cap (float): Total market capitalization of the cryptocurrency.
+        last_updated (datetime.datetime): Timestamp of when this quote was last updated.
+        volume_change_24h (float): Change in 24-hour volume compared to previous period.
+        percent_change_60d (float): Price change percentage over the last 60 days.
+        percent_change_90d (float): Price change percentage over the last 90 days.
+        market_cap_dominance (float): Percentage of total crypto market cap this currency represents.
+        fully_diluted_market_cap (float): Market cap if all tokens were in circulation.
+        tvl (Optional[float]): Total Value Locked in DeFi protocols, if applicable.
+        volume_30d (Optional[float]): 30-day trading volume.
+        volume_30d_reported (Optional[float]): Reported 30-day trading volume from exchanges.
+        volume_24h_reported (Optional[float]): Reported 24-hour trading volume from exchanges.
+        volume_7d_reported (Optional[float]): Reported 7-day trading volume from exchanges.
+        market_cap_by_total_supply (Optional[float]): Market cap calculated using total supply.
+        volume_7d (Optional[float]): 7-day trading volume.
+        total_supply (Optional[float]): Total number of tokens that will ever exist.
+        circulating_supply (Optional[float]): Number of tokens currently in circulation.
+    """
+    base_currency: str
+    price: float
+    volume_24h: float
+    percent_change_1h: float
+    percent_change_24h: float
+    percent_change_7d: float
+    percent_change_30d: float
+    market_cap: float
+    last_updated: datetime.datetime
+
+    # Now all optional/default parameters follow
+    volume_change_24h: float = 0.0
+    percent_change_60d: float = 0.0
+    percent_change_90d: float = 0.0
+    market_cap_dominance: float = 0.0
+    fully_diluted_market_cap: float = 0.0
+    tvl: Optional[float] = None
+    volume_30d: Optional[float] = None
+    volume_30d_reported: Optional[float] = None
+    volume_24h_reported: Optional[float] = None
+    volume_7d_reported: Optional[float] = None
+    market_cap_by_total_supply: Optional[float] = None
+    volume_7d: Optional[float] = None
+    total_supply: Optional[float] = None
+    circulating_supply: Optional[float] = None

byteforge_crypto_commons-0.1/crypto_commons/types/token_state.py

@@ -0,0 +1,64 @@
+from dataclasses import dataclass
+from typing import Dict, List, Optional
+import datetime
+from .quote import Quote
+
+@dataclass
+class TokenState:
+    """Represents the state of a token at a specific moment in time.
+    
+    This class captures all relevant information about a cryptocurrency token at a specific timestamp,
+    including its basic information, market data, supply metrics, and status indicators.
+
+    Required Fields:
+        id: Unique identifier for the token
+        name: Full name of the token
+        symbol: Trading symbol of the token
+        timestamp: The specific moment in time this token state represents
+        quote_map: Dictionary mapping currency codes to Quote objects containing price and volume data
+
+    Optional Fields:
+        last_updated: When this data was last updated in a source system
+        infinite_supply: Whether the token has an infinite supply (e.g., ETH)
+        slug: URL-friendly version of the token name
+        num_market_pairs: Number of active trading pairs for this token
+        creation_date: When the token was first created/launched (e.g., Bitcoin's genesis block)
+        tags: List of categories or labels associated with the token
+        max_supply: Maximum possible supply of the token
+        circulating_supply: Number of tokens currently in circulation
+        total_supply: Total number of tokens that exist (including locked/unreleased)
+        platform: Blockchain platform the token is built on (if applicable)
+        cmc_rank: CoinMarketCap ranking of the token
+        self_reported_circulating_supply: Circulating supply as reported by the token team
+        self_reported_market_cap: Market cap as reported by the token team
+        tvl_ratio: Total Value Locked ratio
+        is_market_cap_included_in_calc: Whether this token's market cap is included in total market calculations
+        is_active: Whether the token is currently active/trading
+        is_fiat: Whether this is a fiat currency
+    """
+    id: int
+    name: str
+    symbol: str
+    timestamp: int  # The specific moment in time this token state represents
+    quote_map: Dict[str, Quote]
+    last_updated: Optional[datetime.datetime] = None  # When this data was last updated in source system
+
+    infinite_supply: bool = None
+    slug: Optional[str] = None
+    num_market_pairs: Optional[int] = None
+    creation_date: Optional[datetime.datetime] = None  # When the token was first created/launched (e.g. Bitcoin's genesis block)
+    tags: Optional[List[str]] = None
+    max_supply: Optional[int] = None
+    circulating_supply: Optional[int] = None
+    total_supply: Optional[float] = None
+    platform: Optional[str] = None
+    cmc_rank: Optional[int] = None
+    self_reported_circulating_supply: Optional[int] = None
+    self_reported_market_cap: Optional[float] = None
+    tvl_ratio: Optional[float] = None
+    is_market_cap_included_in_calc: Optional[bool] = None
+    is_active: Optional[bool] = None
+    is_fiat: Optional[bool] = None
+
+
+

byteforge_crypto_commons-0.1/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "byteforge-crypto-commons"
+version = "0.1"
+description = "Common models and dependencies for crypto projects."
+readme = "README.md"
+license = { file="LICENSE" }
+keywords = ["cryptocurrency", "API", "byteforge-coinmarketcap", "crytpo", "byteforge"]
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+authors = [
+  { name = "Jason Byteforge"}
+]
+dependencies = [
+  "python-dateutil"
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[project.urls]
+Homepage = "https://github.com/jmazzahacks/byteforge-crypto-commons"
+Issues = "https://github.com/jmazzahacks/byteforge-crypto-commons/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["crypto_commons"]

byteforge_crypto_commons-0.1/requirements.txt

@@ -0,0 +1 @@
+python-dateutil