dkg 0.1.0b1__tar.gz

dkg-0.1.0b1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2023 Uladzislau Hubar <hubar.uladzislau@gmail.com>
+
+   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.

dkg-0.1.0b1/PKG-INFO

@@ -0,0 +1,453 @@
+Metadata-Version: 2.1
+Name: dkg
+Version: 0.1.0b1
+Summary: Python library for interacting with the OriginTrail Decentralized Knowledge Graph
+License: Apache-2.0
+Author: Uladzislau Hubar
+Author-email: hubar.uladzislau@gmail.com
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: eth-abi (>=4.0.0,<5.0.0)
+Requires-Dist: eth-account (>=0.8.0,<0.9.0)
+Requires-Dist: hexbytes (>=0.3.0,<0.4.0)
+Requires-Dist: ot-pyld (>=2.1.1,<3.0.0)
+Requires-Dist: pandas (>=1.5.3,<2.0.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: rdflib (>=6.3.2,<7.0.0)
+Requires-Dist: web3 (>=6.0.0,<7.0.0)
+Description-Content-Type: text/markdown
+
+<a name="readme-top"></a>
+
+___
+
+<br />
+<div align="center">
+  <a href="https://github.com/OriginTrail/dkg.py">
+    <img src="images/banner.svg" alt="Python SDK Banner">
+  </a>
+
+  <h3 align="center"><b>dkg.py</b></h3>
+
+  <p align="center">
+    Python SDK for interacting with the OriginTrail Decentralized Knowledge Graph
+    </br>
+    <a href="https://docs.origintrail.io/">OriginTrail Docs</a>
+    ·
+    <a href="https://github.com/OriginTrail/dkg.py/examples/demo.py">View Demo</a>
+    ·
+    <a href="https://github.com/OriginTrail/dkg.py/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/OriginTrail/dkg.py/issues">Request Feature</a>
+  </p>
+</div>
+
+</br>
+
+> **Disclaimer: Beta Version**
+>
+> Welcome to the beta version of our client! This software is currently in the beta testing phase, which means it is not the final release version. As a beta version, it may still contain bugs, undergo frequent updates, and have limited features.
+Important Points to Note:
+
+> **Use at Your Own Risk:** While we have made efforts to ensure the stability and reliability of the beta version, there is a possibility of encountering unexpected issues. Please use this software at your own risk.
+
+> **Limited Support:** As this is a beta release, our support resources may be focused on addressing critical bugs and gathering feedback from users. Therefore, support for beta versions may be limited compared to our stable releases.
+
+> **Feedback Appreciated:** Your feedback is invaluable to us. If you encounter any issues, have suggestions, or want to share your experiences with the beta version, please let us know. Your feedback will help us improve the software for the final release.
+
+> **Not for Production Use:** The beta version is intended for testing and evaluation purposes only. It is not recommended for use in a production environment where stability and reliability are crucial.
+
+</br>
+
+<details open>
+  <summary>
+    <b>Table of Contents</b>
+  </summary>
+  <ol>
+    <li>
+      <a href="#📚-about-the-project">📚 About The Project</a>
+      <ul>
+        <li><a href="#what-is-a-decentralized-knowledge-graph">What is a Decentralized Knowledge Graph?</a></li>
+        <li><a href="#the-origintrail-dkg-architecture">The OriginTrail DKG Architecture</a></li>
+        <li><a href="#what-is-a-knowledge-asset">What is a Knowledge Asset?</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#🚀-getting-started">🚀 Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#📜-roadmap">📜 Roadmap</a>
+      <ul>
+        <li><a href="#1️⃣-pre-development-phase">1️⃣ Pre-development Phase</a></li>
+        <li><a href="#2️⃣-development-phase">2️⃣ Development Phase</a></li>
+        <li><a href="#3️⃣-documentation-phase">3️⃣ Documentation Phase</a></li>
+        <li><a href="#4️⃣-pre-release-phase">4️⃣ Pre-release Phase</a></li>
+        <li><a href="#5️⃣-release">5️⃣ Release</a></li>
+        <li><a href="#6️⃣-post-release">6️⃣ Post-release</a></li>
+      </ul>
+    </li>
+    <li><a href="#📄-license">📄 License</a></li>
+    <li><a href="#🤝-contributing">🤝 Contributing</a></li>
+    <li><a href="#❤️-thanks-to-all-contributors">❤️ Contributors</a></li>
+    <li><a href="#🌟-acknowledgements">🌟 Acknowledgements</a></li>
+    <li><a href="#📰-social-media">📰 Social Media</a></li>
+  </ol>
+</details>
+
+___
+
+<br/>
+
+## 📚 About The Project
+
+<details open>
+<summary>
+
+### <b>What is a Decentralized Knowledge Graph?</b>
+</summary>
+
+<br/>
+
+<div align="center">
+    <img src="images/nodes.png" alt="Knowledge Asset" width="200">
+</div>
+
+There are many available definitions of a knowledge graph, therefore we will present a simplified one focused on usability, rather than completeness. The purpose of this introduction is not to be a comprehensive guide for knowledge graphs, however it aims to get you started with the basics.
+
+A **Knowledge Graph (KG)** is a complex structure that maps the connections and relationships among various entities - be they physical, digital, event-based, or conceptual. Commonly represented as semantic networks, these graphs are leveraged by major corporations such as [Amazon](http://lunadong.com/talks/PG.pdf), [Google](https://en.wikipedia.org/wiki/Google_Knowledge_Graph), [Uber](https://www.youtube.com/watch?v=r3yMSl5NB_Q), and [IBM](https://www.ibm.com/cloud/learn/knowledge-graph) for a wide array of applications, including search, data integration, knowledge reasoning, recommendation engines, analytics, and diverse facets of machine learning and artificial intelligence.
+
+Key characteristics of knowledge graphs include:
+
+- Prioritization of data connections, treating them as "first-class citizens" within the realm of linked data.
+- Designed to accommodate data from diverse sources, supporting a variety of formats.
+- Their data models are flexible and easily extendable, ready to adapt to the evolving nature of data and its relationships.
+
+While knowledge graphs are typically deployed within the boundaries of a single organization to capture knowledge from various internal and external sources, we conceptualize them more broadly. We define the **Decentralized Knowledge Graph (DKG)** as a global, open data structure comprised of interlinked knowledge assets, benefiting both organizations and individuals.
+
+Unique attributes of the DKG are:
+
+- Empowerment of decentralized applications (Dapps) with search, integration, analytics, AI, and ML capabilities across a wide range of data sources, including blockchains, IPFS, enterprise systems, web services, and personal devices.
+- Elimination of the need for a central authority by leveraging decentralized infrastructure.
+- Facilitation of permissionless operations within the public network.
+- Utilization of decentralized identity and Verifiable Credentials for access control, enabling references to private data.
+
+This expansive approach enhances accessibility and flexibility, positioning the DKG as a powerful tool in the evolving digital landscape.
+</details>
+
+<details open>
+<summary>
+
+### <b>The OriginTrail DKG Architecture</b>
+</summary>
+
+<br/>
+
+The OriginTrail tech stack is tailored to enable the discoverability, verifiability, and connectivity of physical and digital assets in a coherent Web3 data ecosystem. It meets two fundamental requirements for such an infrastructure:
+
+- Ensuring trust via decentralized consensus.
+- Utilizing semantic, verifiable asset data to represent complex real-world relationships and characteristics.
+
+OriginTrail achieves this by incorporating two distinct types of technology into two network layers - Blockchains (trust networks) and Knowledge Graphs (semantic data networks).
+
+<div align="center">
+    <img src="images/dkg-architecture1.png" alt="DKG Architecture" width="400">
+</div>
+
+**The DKG layer (Layer 2) consists of multiple sub-layers:**
+
+- **Consensus layer**: Implements interfaces to several blockchains hosting trusted smart contracts used to manage relations between the nodes and implement trustless protocols.
+- **Network layer**: A peer-to-peer swarm of DKG nodes hosted by individuals and organizations.
+- **Data layer**: Hosting the knowledge graph data, distributed across the network in separate instances of graph databases.
+- **Service layer**: Implements various core & extended services like authentication, standard interfaces, and data pipelines.
+- **Application layer**: Includes Dapps and traditional applications that utilize the OriginTrail DKG as part of their data flows.
+
+<div align="center">
+    <img src="images/dkg-architecture2.png" alt="DKG Architecture" width="400">
+</div>
+
+Further, the architecture differentiates between **the public, replicated knowledge graph** shared by all network nodes according to the protocol, and **private graphs** hosted separately by each of the networked nodes.
+
+**The OriginTrail DKG** - combining blockchain and knowledge graph technologies - forms the backbone of the new, trusted Web3 data ecosystem. If you're a developer, you can use it to create, maintain, and use Knowledge Assets across Web3 applications, implementing standardized technologies like GS1 EPCIS, RDF/SPARQL, JSON-LD, and other W3C and GS1 standards right out of the box.
+</details>
+
+<details open>
+<summary>
+
+### <b>What is a Knowledge Asset?</b>
+</summary>
+
+<br/>
+
+<div align="center">
+    <img src="images/ka.png" alt="Knowledge Asset" width="200">
+</div>
+
+**Knowledge Asset is the new, AI‑ready resource for the Internet**
+
+Knowledge Assets are verifiable containers of structured knowledge that live on the OriginTrail DKG and provide:
+- **Discoverability - UAL is the new URL**. Consider Uniform Asset Locators (UALs) a kind of URL that identify a piece of knowledge and make it easy to find and connect with other Knowledge Assets.
+- **Ownership - NFTs enable ownership**. Each Knowledge Asset is created with an NFT token that enables trusted ownership and verifiability of your knowledge.
+- **Verifiability - On-chain information trail**. The blockchain tech increases trust, security, transparency, and the traceability of information.
+
+<br/>
+
+**Discover Knowledge Assets with the DKG Explorer:**
+<div align="center">
+    <table>
+        <tr>
+            <td align="center">
+                <a href="https://dkg.origintrail.io/explore?ual=did:dkg:otp/0x5cac41237127f94c2d21dae0b14bfefa99880630/309100">
+                  <img src="images/knowledge-assets-graph1.svg" width="300" alt="Knowledge Assets Graph 1">
+                </a>
+                <br><b>Supply Chains</b>
+            </td>
+            <td align="center">
+                <a href="https://dkg.origintrail.io/explore?ual=did:dkg:otp/0x5cac41237127f94c2d21dae0b14bfefa99880630/309285">
+                  <img src="images/knowledge-assets-graph2.svg" width="300" alt="Knowledge Assets Graph 2">
+                </a>
+                <br><b>Construction</b>
+            </td>
+            <td align="center">
+                <a href="https://dkg.origintrail.io/explore?ual=did:dkg:otp/0x5cac41237127f94c2d21dae0b14bfefa99880630/309222">
+                  <img src="images/knowledge-assets-graph3.svg" width="300" alt="Knowledge Assets Graph 3">
+                </a>
+                <br><b>Life sciences and healthcare</b>
+            </td>
+            <td align="center">
+                <a href="https://dkg.origintrail.io/explore?ual=did:dkg:otp/0x5cac41237127f94c2d21dae0b14bfefa99880630/308028">
+                  <img src="images/knowledge-assets-graph4.svg" width="300" alt="Knowledge Assets Graph 3">
+                </a>
+                <br><b>Metaverse</b>
+            </td>
+        </tr>
+    </table>
+</div>
+
+
+</details>
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+<br/>
+
+## 🚀 Getting Started
+
+___
+
+### Prerequisites
+
+* python `>=3.11`
+* poetry `>=1.5.1`
+
+___
+<br/>
+
+### Installation
+
+
+Create virtual environment (you can choose any existing folder this command will create configurations and virtual env for python):
+```bash
+python3 -m venv /path/to/folder
+```
+
+Inside of previously generated folder you will find activate script in bin folder and run it:
+```bash
+source /path/to/folder/bin/activate
+```
+
+Install dependencies:
+```bash
+poetry install
+```
+
+Now you can run a demo example file: 
+```bash
+python3 examples/demo.py
+```
+
+<br/>
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## 📜 Roadmap
+
+This roadmap outlines the goals for the first major release of the `dkg.py`. Each section represents a stage in the development process and the features we plan to implement.
+
+<details open>
+<summary>
+
+### 1️⃣ Pre-development Phase
+
+</summary>
+
+- [x] **Requirement Analysis and Planning**
+  - [x] Define the project's scope
+  - [x] Identify the core functionalities
+
+- [x] **Design**
+  - [x] Plan the library's architecture
+  - [x] Establish coding standards
+
+- [ ] **Setup Development Environment**
+  - [x] Setup development, testing and production environments
+  - [ ] Add pytest config
+  - [ ] Add mypy config
+  - [ ] Add tox config ?
+  - [ ] Setup Continuous Integration (CI) and Continuous Deployment (CD) pipeline
+</details>
+
+<details open>
+<summary>
+
+### 2️⃣ Development Phase
+</summary>
+
+| Feature | Status | Tests coverage |
+|:-:|:-:|:-:|
+| Create | 🟩 Completed | ❌ |
+| Transfer | 🟩 Completed | ❌ |
+| Update | 🟩 Completed | ❌ |
+| Wait for finalization | 🟥 Not Started | ❌ |
+| Cancel update | 🟩 Completed | ❌ |
+| Burn | 🟩 Completed | ❌ |
+| Get | 🟩 Completed | ❌ |
+| Query | 🟩 Completed | ❌ |
+| Extend storing period | 🟩 Completed | ❌ |
+| Add tokens | 🟩 Completed | ❌ |
+| Add update tokens | 🟩 Completed | ❌ |
+| Get owner | 🟩 Completed | ❌ |
+| Experimental | 🟥 Not Started | ❌ |
+</details>
+
+<details open>
+<summary>
+
+### 3️⃣ Documentation Phase
+</summary>
+
+- [ ] Write comprehensive documentation
+- [x] Provide examples and use-cases
+- [ ] Review and finalize documentation
+</details>
+
+<details open>
+<summary>
+
+### 4️⃣ Pre-release Phase
+</summary>
+
+- [ ] **Beta Release**
+  - [X] Release a beta version for testing
+  - [ ] Gather and address feedback
+
+- **Bug Fixes**
+  - Identify and fix bugs
+
+- [ ] **Final Testing and QA**
+  - [ ] Perform comprehensive testing
+  - [ ] Ensure the library meets quality standards
+</details>
+
+<details open>
+<summary>
+
+### 5️⃣ Release
+</summary>
+
+- [ ] Merge the first version into the main branch
+- [ ] Release the v1.0.0 of the `dkg.py` library
+</details>
+
+<details open>
+<summary>
+
+### 6️⃣ Post-release
+</summary>
+
+- Monitor for any issues
+- Plan for next versions based on user feedback and usage
+</details>
+
+<br/>
+
+**Note:** This roadmap is subject to changes. Each step will be accompanied by appropriate documentation, testing and code review to maintain the quality of the library.
+
+<br/>
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## 📄 License
+
+Distributed under the Apache-2.0 License. See `LICENSE` file for more information.
+
+<br/>
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## 🤝 Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<br/>
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## ❤️ Thanks to all Contributors!
+
+<!-- readme: <u.hubar>,collaborators,<mucke12>,contributors/- -start -->
+<!-- readme: <u.hubar>,collaborators,<mucke12>,contributors/- -end -->
+
+<br/>
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## 🌟 Acknowledgements
+
+- [web3.py](https://github.com/ethereum/web3.py): Basis for this project
+
+
+<br/>
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## 📰 Social Media
+
+<br/>
+
+<div align="center">
+  <a href="https://medium.com/origintrail">
+    <img src="images/icons/medium.svg" alt="Medium Badge" width="30" style="margin-right: 10px"/>
+  </a>
+  <a href="https://t.me/origintrail">
+    <img src="images/icons/telegram.svg" alt="Telegram Badge" width="30" style="margin-right: 10px"/>
+  </a>
+  <a href="https://x.com/origin_trail">
+    <img src="images/icons/x.svg" alt="X Badge" width="30" style="margin-right: 10px"/>
+  </a>
+  <a href="https://www.youtube.com/c/origintrail">
+    <img src="images/icons/youtube.svg" alt="YouTube Badge" width="30" style="margin-right: 10px"/>
+  </a>
+  <a href="https://www.linkedin.com/company/origintrail/">
+    <img src="images/icons/linkedin.svg" alt="LinkedIn Badge" width="30" style="margin-right: 10px"/>
+  </a>
+  <a href="https://discord.gg/cCRPzzmnNT">
+    <img src="images/icons/discord.svg" alt="Discord Badge" width="30" style="margin-right: 10px"/>
+  </a>
+  <a href="https://www.reddit.com/r/OriginTrail/">
+    <img src="images/icons/reddit.svg" alt="Reddit Badge" width="30" style="margin-right: 10px"/>
+  </a>
+  <a href="https://coinmarketcap.com/currencies/origintrail/">
+    <img src="images/icons/coinmarketcap.svg" alt="Coinmarketcap Badge" width="30" style="margin-right: 10px"/>
+  </a>
+</div>
+
+___
+