# geodefi
**geodefi** is a Python library for interacting with [geode.fi](https://www.geode.fi) smart contract infrastructure.
[geode.fi](https://www.geode.fi) an open source **Decentralized Infrastructure Provider** aiming to create a secure closed-environment for the wider Decentralized Finance landscape.
Currently providing a set of smart contracts which allows anyone to create their own Staking Pool on Ethereum.
Soon, much more.
Built on top of [web3.py](https://web3py.readthedocs.io/en/stable) Geodefi offers a comprehensive set of functions and utilities that simplify the process of interacting with the protocol's smart contract infrastructure.
Whether you're looking to query contract data or execute transactions, **geodefi** Python SDK has you covered! With a user-friendly and highly efficient interface, this SDK also provides cool features such as built-in cache, easy wallet management etc.
## Features
- Supports Ethereum Holesky testnet (as of v2.0.0) where The Protocol is deployed.
- Provides a simple and intuitive API for managing validators, operators, pools, tokens, and other smart contracts/packages.
- Dynamically adapts to the contract upgrades.
- Mostly chain agnostic. However, might differ according to the unique PoS implementations.
- Compatible from Python 3.7 to Python 3.10.
## Installation
```sh
pip install geodefi
```
## Documentation
Detailed documentation for this project is available on [Geodefi SDK Read The Docs](https://sdk.geode.fi).
### Sphinx
If your feature needs to have additional section in [Read The Docs](https://sdk.geode.fi). Please check the docs in your local computer first.
> built docs page is located in docs/_build/html/index.html.
You will need a sphinx server to render rst files:
#### **Build**
```bash
sphinx-build docs docs/_build/html
```
#### **Auto-build**
```bash
sphinx-autobuild docs docs/_build/html
```
## Contributing
We welcome contributions from the community! To contribute to this project, please follow these steps:
1. **Fork the Repository**: Click the "Fork" button at the top right corner of this repository to create your own copy.
2. **Clone the Repository**: Clone the forked repository to your local machine using the following command:
```bash
git clone https://github.com/<your_user_name>/geode-py.git
```
3. **Virtual Environment (adviced)** Open virtual environment for python.
```bash
sudo pip install virtualenv
python3 -m venv {path}
source {path}/bin/activate
pip install -r requirements.txt
```
4. **Create a Branch**: Create a new branch for your contribution:
```bash
git checkout -b feature/your-feature-name
```
5. **Stage Changes**: Stage your changes to be commited
```bash
git add <your-modified-files>
```
6. **Commit Changes**: Commit your changes with a descriptive commit message:
```bash
git commit -m "Add feature: your feature description"
```
7. **Push Changes**: Push your changes to your forked repository:
```bash
git push origin feature/your-feature-name
```
8. **Create a Pull Request**: Go to the original repository on GitHub and click on the "Pull Request" button. Fill out the necessary information and submit the pull request. Your pull request will be reviewed by the maintainers. Be ready to respond to any feedback or changes requested. You might need to make additional commits based on the feedback.
## Release
- Use main branch for releases.
- test with ``VERSION=1.0.0 python -m build`` if you want, then:
``` bash
git tag -a "v0.0.1-beta" -m "beta version testing"
git push --tags
```
## License
`geodefi` python sdk is licensed under MIT.
Raw data
{
"_id": null,
"home_page": "https://www.geode.fi/",
"name": "geodefi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "ethereum,geode,web3",
"author": "IceBear",
"author_email": "admin@geode.fi",
"download_url": "https://files.pythonhosted.org/packages/07/ff/7f5e691c2001bf1db9005aaef76ca60c716828533ecf6c503e8273bfd936/geodefi-2.0.1.tar.gz",
"platform": null,
"description": "# geodefi\n\n**geodefi** is a Python library for interacting with [geode.fi](https://www.geode.fi) smart contract infrastructure.\n\n[geode.fi](https://www.geode.fi) an open source **Decentralized Infrastructure Provider** aiming to create a secure closed-environment for the wider Decentralized Finance landscape.\nCurrently providing a set of smart contracts which allows anyone to create their own Staking Pool on Ethereum.\nSoon, much more.\n\nBuilt on top of [web3.py](https://web3py.readthedocs.io/en/stable) Geodefi offers a comprehensive set of functions and utilities that simplify the process of interacting with the protocol's smart contract infrastructure.\n\nWhether you're looking to query contract data or execute transactions, **geodefi** Python SDK has you covered! With a user-friendly and highly efficient interface, this SDK also provides cool features such as built-in cache, easy wallet management etc.\n\n## Features\n\n- Supports Ethereum Holesky testnet (as of v2.0.0) where The Protocol is deployed.\n- Provides a simple and intuitive API for managing validators, operators, pools, tokens, and other smart contracts/packages.\n- Dynamically adapts to the contract upgrades.\n- Mostly chain agnostic. However, might differ according to the unique PoS implementations.\n- Compatible from Python 3.7 to Python 3.10.\n\n## Installation\n\n```sh\npip install geodefi\n```\n\n## Documentation\n\nDetailed documentation for this project is available on [Geodefi SDK Read The Docs](https://sdk.geode.fi).\n\n### Sphinx\n\nIf your feature needs to have additional section in [Read The Docs](https://sdk.geode.fi). Please check the docs in your local computer first.\n\n> built docs page is located in docs/_build/html/index.html.\n\nYou will need a sphinx server to render rst files:\n\n#### **Build**\n\n```bash\nsphinx-build docs docs/_build/html\n```\n\n#### **Auto-build**\n\n```bash\nsphinx-autobuild docs docs/_build/html\n```\n\n## Contributing\n\nWe welcome contributions from the community! To contribute to this project, please follow these steps:\n\n1. **Fork the Repository**: Click the \"Fork\" button at the top right corner of this repository to create your own copy.\n\n2. **Clone the Repository**: Clone the forked repository to your local machine using the following command:\n\n ```bash\n git clone https://github.com/<your_user_name>/geode-py.git\n ```\n\n3. **Virtual Environment (adviced)** Open virtual environment for python.\n\n ```bash\n sudo pip install virtualenv\n python3 -m venv {path}\n source {path}/bin/activate\n\n pip install -r requirements.txt\n ```\n\n4. **Create a Branch**: Create a new branch for your contribution:\n\n ```bash\n git checkout -b feature/your-feature-name\n ```\n\n5. **Stage Changes**: Stage your changes to be commited\n\n ```bash\n git add <your-modified-files>\n ```\n\n6. **Commit Changes**: Commit your changes with a descriptive commit message:\n\n ```bash\n git commit -m \"Add feature: your feature description\"\n ```\n\n7. **Push Changes**: Push your changes to your forked repository:\n\n ```bash\n git push origin feature/your-feature-name\n ```\n\n8. **Create a Pull Request**: Go to the original repository on GitHub and click on the \"Pull Request\" button. Fill out the necessary information and submit the pull request. Your pull request will be reviewed by the maintainers. Be ready to respond to any feedback or changes requested. You might need to make additional commits based on the feedback.\n\n## Release\n\n- Use main branch for releases.\n- test with ``VERSION=1.0.0 python -m build`` if you want, then:\n\n``` bash\n git tag -a \"v0.0.1-beta\" -m \"beta version testing\"\n git push --tags\n```\n\n## License\n\n`geodefi` python sdk is licensed under MIT.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python SDK for Geodefi Ecosystem",
"version": "2.0.1",
"project_urls": {
"Homepage": "https://www.geode.fi/"
},
"split_keywords": [
"ethereum",
"geode",
"web3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e653c16da5464fe560f269383f78e2097cea240c8787df68dd4aea59f483363d",
"md5": "ab11696342afc70906527cf3a5abeab0",
"sha256": "86d7932f1cd9f14e2f1b24f9a383e01ef3603e485e15a195f2b4fe2984953c2d"
},
"downloads": -1,
"filename": "geodefi-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ab11696342afc70906527cf3a5abeab0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 270128,
"upload_time": "2024-03-08T21:28:34",
"upload_time_iso_8601": "2024-03-08T21:28:34.791565Z",
"url": "https://files.pythonhosted.org/packages/e6/53/c16da5464fe560f269383f78e2097cea240c8787df68dd4aea59f483363d/geodefi-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "07ff7f5e691c2001bf1db9005aaef76ca60c716828533ecf6c503e8273bfd936",
"md5": "53310e6e1c7776b60dc0a83d7f3c1272",
"sha256": "a80d9d18b57da38227779a4c25545891ac17df95009957961b9eb1aae80db2d0"
},
"downloads": -1,
"filename": "geodefi-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "53310e6e1c7776b60dc0a83d7f3c1272",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 268201,
"upload_time": "2024-03-08T21:28:36",
"upload_time_iso_8601": "2024-03-08T21:28:36.945677Z",
"url": "https://files.pythonhosted.org/packages/07/ff/7f5e691c2001bf1db9005aaef76ca60c716828533ecf6c503e8273bfd936/geodefi-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-08 21:28:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "geodefi"
}
JSON