Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,6 @@ Cryptnox Pro
.. image:: https://img.shields.io/pypi/v/cryptnoxpro
:target: https://pypi.org/project/cryptnoxpro


**Warning: This is a beta release of the software.
It is released for development purposes.
Use at your own risk.**

A command line user interface to manage and use of `Cryptnox Smart cards <https://www.cryptnox.com/>`_.

This provides basic wallets for `Bitcoin <https://bitcoin.org>`_ and
Expand Down
69 changes: 58 additions & 11 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

import os
import sys

sys.path.insert(0, os.path.abspath(".."))

project = 'cryptnoxpro'
Expand All @@ -25,33 +26,79 @@
"sphinx.ext.viewcode",
]

# Disable autosummary generation to prevent hangs
autosummary_generate = False

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# autodoc_mock_imports - Sphinx will create mock imports for these modules
# This is safer than manual sys.modules mocking and prevents hangs
autodoc_mock_imports = [
'winsdk',
# Cryptnox
'cryptnoxpy',
'boto3',
'botocore',
'cryptography',
# Input/Output
'stdiomask',
'tabulate',
'requests',
# AWS
'boto3',
'botocore',
'botocore.exceptions',
'botocore.client',
'botocore.config',
# Web3 and Ethereum
'web3',
'eth_typing',
'web3.eth',
'web3.contract',
'web3.middleware',
'eth_account',
'eth_account._utils',
'eth_account._utils.legacy_transactions',
'eth_account.transactions',
'eth_account.account',
'eth_account._utils',
'eth_account.datastructures',
'pydantic',
'pydantic_core',
'eth_utils',
'eth_utils.curried',
'eth_typing',
'eth_keys',
'eth_rlp',
'eth_abi',
'eth_hash',
'hexbytes',
'enums',
'config'
'ecdsa',
'rlp',
# Validation
'pydantic',
'pydantic_core',
# Smart card
'pyscard',
'smartcard',
'smartcard.CardConnection',
'smartcard.System',
'smartcard.Exceptions',
'smartcard.CardType',
'smartcard.CardRequest',
'smartcard.util',
'smartcard.scard',
# Utilities
'cytoolz',
'toolz',
'winsdk',
'base58',
]

# Autodoc configuration
autodoc_default_options = {
'members': True,
'member-order': 'bysource',
'special-members': '__init__',
'undoc-members': True,
'exclude-members': '__weakref__'
}

# Set autodoc to not fail on import errors
autoclass_content = 'both'

# Handle ambiguous cross-references
nitpicky = False
nitpick_ignore = [
Expand Down
14 changes: 14 additions & 0 deletions docs/cryptnoxpro.command.card.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,17 @@ Module contents
:undoc-members:
:show-inheritance:

The ``cryptnoxpro.command.card`` package provides card management functionality and exports:

.. py:currentmodule:: cryptnoxpro.command.card

.. py:class:: Info
:no-index:

Command class for displaying card information. See :class:`cryptnoxpro.command.card.info.Info` for details.

.. py:class:: Initialize
:no-index:

Command class for initializing cards. See :class:`cryptnoxpro.command.card.initialize.Initialize` for details.

14 changes: 14 additions & 0 deletions docs/cryptnoxpro.command.erc_token.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,17 @@ Module contents
:undoc-members:
:show-inheritance:

The ``cryptnoxpro.command.erc_token`` package provides ERC token management and exports:

.. py:currentmodule:: cryptnoxpro.command.erc_token

.. py:class:: Info
:no-index:

Command class for displaying ERC token information. See :class:`cryptnoxpro.command.erc_token.info.Info` for details.

.. py:class:: Initialize
:no-index:

Command class for initializing ERC tokens. See :class:`cryptnoxpro.command.erc_token.initialize.Initialize` for details.

4 changes: 4 additions & 0 deletions docs/cryptnoxpro.command.helper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,7 @@ Module contents
:undoc-members:
:show-inheritance:

The ``cryptnoxpro.command.helper`` package provides utility functions and helper modules for command implementations.
This package contains shared functionality used across multiple commands, including user interface components,
security helpers, configuration management, and backup utilities.

9 changes: 9 additions & 0 deletions docs/cryptnoxpro.command.options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,12 @@ Module contents
:undoc-members:
:show-inheritance:

The ``cryptnoxpro.command.options`` package provides command-line argument parsing and exports:

.. py:currentmodule:: cryptnoxpro.command.options

.. py:function:: add(subparsers, command_class)
:no-index:

Add command-line options for a command class. See :func:`cryptnoxpro.command.options.options.add` for details.

3 changes: 3 additions & 0 deletions docs/cryptnoxpro.command.rst
Original file line number Diff line number Diff line change
Expand Up @@ -200,3 +200,6 @@ Module contents
:undoc-members:
:show-inheritance:

The ``cryptnoxpro.command`` package provides command-line interface commands for interacting with Cryptnox cards.
This package contains all command implementations that can be executed from the CLI.

24 changes: 24 additions & 0 deletions docs/cryptnoxpro.command.user_keys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,27 @@ Module contents
:undoc-members:
:show-inheritance:

The ``cryptnoxpro.command.user_keys`` package provides authentication functionality and exports:

.. py:currentmodule:: cryptnoxpro.command.user_keys

.. py:function:: add(data)
:no-index:

Add a new authentication method. See :func:`cryptnoxpro.command.user_keys.authentication.add` for details.

.. py:function:: authenticate(data)
:no-index:

Authenticate using a configured method. See :func:`cryptnoxpro.command.user_keys.authentication.authenticate` for details.

.. py:function:: delete(data)
:no-index:

Delete an authentication method. See :func:`cryptnoxpro.command.user_keys.authentication.delete` for details.

.. py:function:: get(data)
:no-index:

Get information about authentication methods. See :func:`cryptnoxpro.command.user_keys.authentication.get` for details.

9 changes: 9 additions & 0 deletions docs/cryptnoxpro.lib.cryptos.coins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,12 @@ Module contents
:undoc-members:
:show-inheritance:

The ``cryptnoxpro.lib.cryptos.coins`` package provides cryptocurrency coin implementations and exports:

.. py:currentmodule:: cryptnoxpro.lib.cryptos.coins

.. py:class:: Bitcoin
:no-index:

Bitcoin cryptocurrency implementation. See :class:`cryptnoxpro.lib.cryptos.coins.bitcoin.Bitcoin` for details.

16 changes: 16 additions & 0 deletions docs/cryptnoxpro.lib.cryptos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,3 +140,19 @@ Module contents
:undoc-members:
:show-inheritance:

The ``cryptnoxpro.lib.cryptos`` package provides cryptocurrency utilities and re-exports functionality from:

* :mod:`cryptnoxpro.lib.cryptos.blocks` - Block-related utilities
* :mod:`cryptnoxpro.lib.cryptos.composite` - Composite key handling
* :mod:`cryptnoxpro.lib.cryptos.deterministic` - Deterministic wallet functions
* :mod:`cryptnoxpro.lib.cryptos.main` - Main crypto operations
* :mod:`cryptnoxpro.lib.cryptos.mnemonic` - Mnemonic phrase handling
* :mod:`cryptnoxpro.lib.cryptos.specials` - Special cryptocurrency operations
* :mod:`cryptnoxpro.lib.cryptos.stealth` - Stealth address support
* :mod:`cryptnoxpro.lib.cryptos.transaction` - Transaction handling
* :mod:`cryptnoxpro.lib.cryptos.coins` - Coin implementations
* :mod:`cryptnoxpro.lib.cryptos.keystore` - Key storage utilities
* :mod:`cryptnoxpro.lib.cryptos.wallet` - Wallet functionality

All public members from these modules are available directly from ``cryptnoxpro.lib.cryptos``.

3 changes: 3 additions & 0 deletions docs/cryptnoxpro.lib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,6 @@ Module contents
:undoc-members:
:show-inheritance:

The ``cryptnoxpro.lib`` package provides library functionality for cryptocurrency operations.
The main subpackage is :mod:`cryptnoxpro.lib.cryptos` which contains comprehensive cryptocurrency utilities.

8 changes: 8 additions & 0 deletions docs/cryptnoxpro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,11 @@ Module contents
:undoc-members:
:show-inheritance:

The main ``cryptnoxpro`` package exports:

.. py:data:: __version__
:type: str
:value: "2.9.1"

Current version of the CryptnoxPro package.

24 changes: 24 additions & 0 deletions docs/cryptnoxpro.wallet.eth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,27 @@ Module contents
:undoc-members:
:show-inheritance:

The ``cryptnoxpro.wallet.eth`` package provides Ethereum wallet utilities and exports:

.. py:currentmodule:: cryptnoxpro.wallet.eth

.. py:function:: address(public_key)
:no-index:

Generate an Ethereum address from a public key. See :func:`cryptnoxpro.wallet.eth.api.address` for details.

.. py:class:: Api
:no-index:

Ethereum API interface. See :class:`cryptnoxpro.wallet.eth.api.Api` for details.

.. py:function:: checksum_address(address_str)
:no-index:

Convert an address to checksummed format. See :func:`cryptnoxpro.wallet.eth.api.checksum_address` for details.

.. py:class:: EthValidator
:no-index:

Ethereum address and transaction validator. See :class:`cryptnoxpro.wallet.eth.api.EthValidator` for details.

3 changes: 3 additions & 0 deletions docs/cryptnoxpro.wallet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,6 @@ Module contents
:undoc-members:
:show-inheritance:

The ``cryptnoxpro.wallet`` package provides wallet functionality for various cryptocurrencies.
It includes Bitcoin wallet operations, Ethereum wallet utilities, and validation functions.