cyhole 0.0.1a0__tar.gz

cyhole-0.0.1a0/.github/workflows/publish-doc.yml

@@ -0,0 +1,38 @@
+name: publish-doc
+
+on:
+  release:
+    types: [created]
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: deploy a new version of cyhole library documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      # set up environment
+      - name: setup python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.12
+      - name: install pip
+        run: python -m pip install --upgrade pip
+      - name: install dependencies
+        run: pip install -r docs/requirements.txt
+
+      # setup git bot credentials
+      - run: git config user.name github-actions[bot]
+      - run: git config user.email github-actions[bot]@users.noreply.github.com
+
+      - name: deploy documentstion
+        run: mkdocs gh-deploy --force
+      
+      # check workflow output
+      - name: dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"

cyhole-0.0.1a0/.github/workflows/publish-version.yml

@@ -0,0 +1,45 @@
+name: publish-version
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    name: deploy a new version of cyhole library
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      # set up environment
+      - name: set up python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.12
+      - name: install pip
+        run: python -m pip install --upgrade pip
+      - name: install dependencies
+        run: pip install -r src/requirements.txt
+      - name: install build
+        run: python -m pip install --upgrade build
+
+      # update library version equals release
+      - name: update version in pyproject.toml
+        run: sed -i "s/{{PROJET_VERSION}}/${{ github.event.release.tag_name }}/g" pyproject.toml
+
+      # build package
+      - name: build a binary wheel and a source tarball
+        run: python -m build --sdist --wheel --outdir dist/
+
+      # publish on pypi
+      - name: publish package
+        uses: pypa/gh-action-pypi-publish@v1.8.14
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+      # check workflow output
+      - name: dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"

cyhole-0.0.1a0/.gitignore

@@ -0,0 +1,6 @@
+cyhole.code-workspace
+/gitignore
+/**/__pycache__
+/tests/resources
+/tests/test.ini
+/.vscode

cyhole-0.0.1a0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Andrea Zanini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cyhole-0.0.1a0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.3
+Name: cyhole
+Version: 0.0.1a0
+Summary: cyhole, designed to help python's developers to interact to the most popular external API services in crypto and create automation processes.
+Project-URL: Homepage, https://github.com/zazza123/cyhole
+Project-URL: Repository, https://github.com/zazza123/cyhole
+Author: Andrea Zanini
+License-File: LICENSE
+Classifier: Development Status :: 1 - Planning
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Pydantic
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/zazza123/cyhole/main/docs/config/images/logo.png" alt="cyhole" class="img-logo">
+</p>
+
+---
+
+**cyhole** is designed to help python's developers to interact to the most popular external API services in crypto world and create automation processes.
+
+Each external API integrated into the library is referred to as an *Interaction*, providing developers with a comprehensive toolkit for retrieving real-time market data, historical trends, account information, and more.
+
+<u>Key Features</u>
+
+  - *Centralized Access*: access multiple cryptocurrency APIs through a single interface.
+  - *Comprehensive Coverage*: explore a wide range of cryptocurrency data, including market prices, trading volumes, and blockchain statistics.
+  - *Simplified Development*: accelerate the development process by leveraging pre-built API integrations.
+  - *Flexible Integration*: seamlessly incorporate cyhole into Python projects, whether building automated trading algorithms or monitoring cryptocurrency portfolios.
+
+The installation is performed via `pip` by running:
+
+```sh
+pip install cyhole
+```
+
+## Interactions
+
+In **cyhole**, Interactions serve as the fundamental components, akin to the building blocks of a scientific model. Each interaction represents a distinct cryptocurrency API, providing developers with access to essential data and metrics.
+
+The current supported external/interactions APIs are:
+
+|Site                             |Path             |Connector|
+|----                             |----             |---------|
+|[birdeye.so](https://birdeye.so) |`cyhole.birdeye` |`Birdeye`|

cyhole-0.0.1a0/README.md

@@ -0,0 +1,32 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/zazza123/cyhole/main/docs/config/images/logo.png" alt="cyhole" class="img-logo">
+</p>
+
+---
+
+**cyhole** is designed to help python's developers to interact to the most popular external API services in crypto world and create automation processes.
+
+Each external API integrated into the library is referred to as an *Interaction*, providing developers with a comprehensive toolkit for retrieving real-time market data, historical trends, account information, and more.
+
+<u>Key Features</u>
+
+  - *Centralized Access*: access multiple cryptocurrency APIs through a single interface.
+  - *Comprehensive Coverage*: explore a wide range of cryptocurrency data, including market prices, trading volumes, and blockchain statistics.
+  - *Simplified Development*: accelerate the development process by leveraging pre-built API integrations.
+  - *Flexible Integration*: seamlessly incorporate cyhole into Python projects, whether building automated trading algorithms or monitoring cryptocurrency portfolios.
+
+The installation is performed via `pip` by running:
+
+```sh
+pip install cyhole
+```
+
+## Interactions
+
+In **cyhole**, Interactions serve as the fundamental components, akin to the building blocks of a scientific model. Each interaction represents a distinct cryptocurrency API, providing developers with access to essential data and metrics.
+
+The current supported external/interactions APIs are:
+
+|Site                             |Path             |Connector|
+|----                             |----             |---------|
+|[birdeye.so](https://birdeye.so) |`cyhole.birdeye` |`Birdeye`|

cyhole-0.0.1a0/docs/config/css/mkdocstrings.css

@@ -0,0 +1,6 @@
+/* Indentation. */
+div.doc-contents:not(.first) {
+    padding-left: 10px;
+    border-left: 3px solid var(--md-code-bg-color);
+    margin-bottom: 25px;
+}

cyhole-0.0.1a0/docs/config/overrides/partials/toc-item.html

@@ -0,0 +1,18 @@
+<!-- Solution suggested in https://github.com/squidfunk/mkdocs-material/issues/4827 -->
+<li class="md-nav__item">
+    <a href="{{ toc_item.url }}" class="md-nav__link">
+        <span class="md-ellipsis">
+            {{ toc_item.title }}
+        </span>
+    </a>
+
+    <!-- Table of contents list -->
+    {% if toc_item.children %}
+    <nav class="md-nav" aria-label="{{ toc_item.title | striptags }}">
+        <ul class="md-nav__list">
+            {% for toc_item in toc_item.children %}
+            {% if not page.meta.toc_depth or toc_item.level <= page.meta.toc_depth %} {%
+                include "partials/toc-item.html" %} {% endif %} {% endfor %} </ul>
+    </nav>
+    {% endif %}
+</li>

cyhole-0.0.1a0/docs/development/core/api.md

@@ -0,0 +1,3 @@
+# Connector
+
+::: cyhole.core.api

cyhole-0.0.1a0/docs/development/core/exception.md

@@ -0,0 +1,5 @@
+# Exceptions
+
+::: cyhole.core.exception
+    options:
+        show_if_no_docstring: true

cyhole-0.0.1a0/docs/development/core/index.md

@@ -0,0 +1,6 @@
+# :material-atom: - Core
+
+This section focuses on the description of the library's most internal tools that could be used to develop new API `Interactions`.
+
+!!! warning
+    :material-hammer-wrench: - Section under construction.

cyhole-0.0.1a0/docs/development/core/param.md

@@ -0,0 +1,3 @@
+# API Parameters
+
+::: cyhole.core.param

cyhole-0.0.1a0/docs/development/index.md

@@ -0,0 +1,29 @@
+# :octicons-code-24: - Development
+
+This section is intended to all the developers who want to contribute to the project by:
+
+- fixing one or more bugs
+- improving the library
+- creating a new `Interaction`
+
+Depending on the scope, different actions should be taken into consideration.
+
+## Bug & Improvements
+
+!!! warning
+    :material-hammer-wrench: - Section under construction.
+
+## New Interactions
+
+!!! warning
+    :material-hammer-wrench: - Section under construction.
+
+## Pull Requests
+
+!!! warning
+    :material-hammer-wrench: - Section under construction.
+
+## Testing
+
+!!! warning
+    :material-hammer-wrench: - Section under construction.

cyhole-0.0.1a0/docs/index.md

@@ -0,0 +1,23 @@
+---
+hide:
+  - navigation
+---
+
+<style>
+.md-content .md-typeset h1 {
+  display: none;
+}
+
+.img-logo {
+  display: none;
+}
+</style>
+
+<div style="display: flex; align-items: center; justify-content: center;">
+  <svg width="6em" height="6em" viewBox="0 0 24 24">
+      <path fill = "currentColor" d = "m12 6.7l1.45 3.85L17.3 12l-3.85 1.45L12 17.3l-1.45-3.85L6.7 12l3.85-1.45zM12 1L9 9l-8 3l8 3l3 8l3-8l8-3l-8-3z" />
+  </svg>
+  <span style="margin-left: 10px; font-size: 4em;">cyhole</span>
+</div>
+
+--8<-- "README.md"

cyhole-0.0.1a0/docs/interactions/birdeye/api.md

@@ -0,0 +1,7 @@
+# Connector
+
+Connector page for the birdeye.so API.  
+Each endpoint is mapped and callable via a dedicated method.  
+Be sure to call an endpoint in line with the permissions of your API.
+
+::: cyhole.birdeye.Birdeye

cyhole-0.0.1a0/docs/interactions/birdeye/exception.md

@@ -0,0 +1,5 @@
+# Exceptions
+
+::: cyhole.birdeye.exception
+    options:
+        show_if_no_docstring: true

cyhole-0.0.1a0/docs/interactions/birdeye/index.md

@@ -0,0 +1,64 @@
+# :material-bird: - Birdeye
+
+Birdeye ([https://birdeye.so](https://birdeye.so)) is a popular treading crypto platform connected to different blockchains that provides tokens data and pairs' prices in real time. The access to both their public and private APIs is managed by a valid API key requestable on their site.
+
+The API connector is [`Birdeye`](../birdeye/api.md) class imported from `cyhole.birdeye` path.
+
+## Quick Example
+
+Extract the latest tokens from Ethereum chain sorted in descending order by USD volume in few lines of code.
+
+```py
+from cyhole.birdeye import Birdeye
+from cyhole.birdeye.param import BirdeyeChain
+
+api = Birdeye()
+token_list = api.get_token_list(chain = BirdeyeChain.ETHEREUM.value)
+
+for token in token_list:
+    print(token)
+```
+
+!!! note
+    To run this example is assumed that the user has a valid API key stored in `BIRDEYE_API_KEY` environment variable.  
+    If the key is not provided during the object creations, then the library will raise an exception.
+
+## Content
+
+The documentation follows the library's structure by providing all the technical details required to use it.
+
+<div class="grid cards" markdown>
+
+-   :material-connection:{ .lg .middle } __Connector__
+
+    ---
+
+    `cyhole.birdeye` - Explore the [`Birdeye`](../birdeye/api.md) API connector and all its methods. 
+
+    [:octicons-arrow-right-24: Reference](../birdeye/api.md)
+
+-   :material-list-status:{ .lg .middle } __API Parameters__
+
+    ---
+
+    `cyhole.birdeye.param` - Ensure to use the correct parameters during the API calls.
+
+    [:octicons-arrow-right-24: Reference](../birdeye/param.md)
+
+-   :material-graph:{ .lg .middle } __Response Schema__
+
+    ---
+
+    `cyhole.birdeye.schema` - Extract only what is necessary by exploiting reponse mapping thanks to `pydantic` schemes.
+
+    [:octicons-arrow-right-24: Reference](../birdeye/schema.md)
+
+-   :octicons-stop-24:{ .lg .middle } __Exceptions__
+
+    ---
+
+    `cyhole.birdeye.exception` - Make sure you intercept all exceptions correctly.
+
+    [:octicons-arrow-right-24: Reference](../birdeye/exception.md)
+
+</div>

cyhole-0.0.1a0/docs/interactions/birdeye/param.md

@@ -0,0 +1,5 @@
+# API Parameters
+
+Some endpoints require input parameters belonging to specific domains. On this page, all domains can be found in order to be in line with the standards required by the API.
+
+::: cyhole.birdeye.param

cyhole-0.0.1a0/docs/interactions/birdeye/schema.md

@@ -0,0 +1,20 @@
+---
+toc_depth: 3
+---
+# Response Schema
+
+Each response has been mapped into a `pydantic` schema in a way that makes it easy to read and write codes that use them.
+
+The classes identifying the response schema of an endpoint are the only ones ending with `Response` word, all other sub-schemes are used to identify the structures obtained from the responses.
+
+!!! tip "Schema Enhancement"
+
+    If some schema are __incorrect__ or __needs to be enhanced__ (optional/mandatory fields changes, incorrect datatype or schema update) feel free to open a pull request or issue by attaching:
+
+        - method
+        - endpoint call executed
+        - response obtained
+
+::: cyhole.birdeye.schema
+    options:
+        show_if_no_docstring: true

cyhole-0.0.1a0/docs/requirements.txt

@@ -0,0 +1,3 @@
+mkdocs-material>=9.5.21
+mkdocstrings-python>=1.10.0
+black>=24.4.2

cyhole-0.0.1a0/mkdocs.yml

@@ -0,0 +1,108 @@
+site_name: cyhole
+
+repo_url: https://github.com/zazza123/cyhole
+repo_name: zazza123/cyhole
+
+theme:
+  name: material
+  custom_dir: docs/config/overrides
+  language: en
+  icon:
+    logo: material/star-four-points-outline
+  features:
+    - navigation.instant
+    - navigation.instant.progress
+    - navigation.tabs
+    - navigation.top
+    - navigation.sections
+    - navigation.expand
+    - navigation.indexes
+    - toc.follow
+    - search.suggest
+    - content.code.copy
+  palette:
+    # Light Mode Palette
+    - media: "(prefers-color-scheme: light)"
+      primary: black
+      scheme: default
+      toggle:
+        icon: octicons/moon-24
+        name: Switch to Dark Mode
+    # Dark Mode Palette
+    - media: "(prefers-color-scheme: dark)"
+      primary: white
+      scheme: slate
+      toggle:
+        icon: octicons/sun-24
+        name: Switch to Light Mode
+
+plugins:
+  - search
+  - offline
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [src]
+          options:
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            show_inheritance_diagram: true
+            show_root_heading: true
+            merge_init_into_class: true
+            annotations_path: source
+            separate_signature: true
+            show_signature_annotations: true
+            members_order: source
+            #signature_crossrefs: true
+
+markdown_extensions:
+
+  # Python Markdown
+  - abbr
+  - admonition
+  - attr_list
+  - md_in_html
+  - def_list
+  - footnotes
+  - toc:
+      permalink: true
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+
+  # Python Markdown Extensions
+  - pymdownx.snippets
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.mark
+  - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+
+# Navigation
+nav:
+  - Home: index.md
+  - Interactions:
+    - Birdeye:
+      - interactions/birdeye/index.md
+      - Connector: interactions/birdeye/api.md
+      - API Parameters: interactions/birdeye/param.md
+      - Response Schema: interactions/birdeye/schema.md
+      - Exceptions: interactions/birdeye/exception.md
+  - Development:
+    - development/index.md
+    - Core:
+      - development/core/index.md
+      - Connector: development/core/api.md
+      - API Parameters: development/core/param.md
+      - Exceptions: development/core/exception.md
+
+extra_css:
+  - config/css/mkdocstrings.css

cyhole-0.0.1a0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "cyhole"
+version = "0.0.1-alpha"
+description = "cyhole, designed to help python's developers to interact to the most popular external API services in crypto and create automation processes."
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [
+    { name = "Andrea Zanini", email= "" },
+]
+classifiers = [
+    "Development Status :: 1 - Planning",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Environment :: Web Environment",
+    "Framework :: Pydantic",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: Financial and Insurance Industry"
+]
+
+[project.urls]
+Homepage = "https://github.com/zazza123/cyhole"
+Repository = "https://github.com/zazza123/cyhole"
+
+[tool.pytest.ini_options]
+addopts = [
+    "--import-mode=importlib",
+]