chain-index


Namechain-index JSON
Version 0.2.5 PyPI version JSON
download
home_pageNone
SummaryA Python library for managing and organizing AI language model chains
upload_time2024-12-28 18:09:32
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseMIT License Copyright (c) 2023 Your Name or Organization 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.
keywords web3 ethereum blockchain evm
VCS
bugtrack_url
requirements pydantic typing-extensions
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
## API Reference

### `get_chain_info(chain_identifier: Union[int, str]) -> ChainInfo`

Retrieves chain information based on the provided identifier.

- `chain_identifier`: Can be an integer (chain ID) or a string (chain name or alias)
- Returns a `ChainInfo` object containing chain details
- Raises `ChainNotFoundError` if the chain is not found

### `ChainInfo`

A Pydantic model representing chain information. Key attributes include:

- `name`: Chain name
- `chainId`: Chain ID
- `nativeCurrency`: Native currency details (name, symbol, decimals)
- `wrapperNativeCurrency`: Wrapper native currency details (name, symbol, decimals, contract)
- `rpc`: List of RPC URLs
- `explorers`: List of block explorers

## Development

To set up the development environment:

1. Clone the repository
2. Install development dependencies: `pip install -e ".[dev]"`
3. Run tests: `pytest`

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgements

This project uses data from the [chainid.network](https://chainid.network/) project, which provides a comprehensive list of EVM-compatible chains.

## Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for a detailed history of changes to this project.

## Authors

- gmatrix - Initial work and maintenance

## Disclaimer

This package is provided as-is, and while we strive for accuracy, we cannot guarantee the correctness of all chain information. Users should verify critical information independently.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "chain-index",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "web3, ethereum, blockchain, evm",
    "author": null,
    "author_email": "gmatrix <gmatrixuniverse@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/45/b2/909ce6314017fd25dee6a10e5da11eef63008dc8c11c608987dbf4bd5d96/chain-index-0.2.5.tar.gz",
    "platform": null,
    "description": "\n## API Reference\n\n### `get_chain_info(chain_identifier: Union[int, str]) -> ChainInfo`\n\nRetrieves chain information based on the provided identifier.\n\n- `chain_identifier`: Can be an integer (chain ID) or a string (chain name or alias)\n- Returns a `ChainInfo` object containing chain details\n- Raises `ChainNotFoundError` if the chain is not found\n\n### `ChainInfo`\n\nA Pydantic model representing chain information. Key attributes include:\n\n- `name`: Chain name\n- `chainId`: Chain ID\n- `nativeCurrency`: Native currency details (name, symbol, decimals)\n- `wrapperNativeCurrency`: Wrapper native currency details (name, symbol, decimals, contract)\n- `rpc`: List of RPC URLs\n- `explorers`: List of block explorers\n\n## Development\n\nTo set up the development environment:\n\n1. Clone the repository\n2. Install development dependencies: `pip install -e \".[dev]\"`\n3. Run tests: `pytest`\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgements\n\nThis project uses data from the [chainid.network](https://chainid.network/) project, which provides a comprehensive list of EVM-compatible chains.\n\n## Support\n\nIf you encounter any issues or have questions, please file an issue on the GitHub repository.\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md) for a detailed history of changes to this project.\n\n## Authors\n\n- gmatrix - Initial work and maintenance\n\n## Disclaimer\n\nThis package is provided as-is, and while we strive for accuracy, we cannot guarantee the correctness of all chain information. Users should verify critical information independently.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Your Name or Organization  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. ",
    "summary": "A Python library for managing and organizing AI language model chains",
    "version": "0.2.5",
    "project_urls": {
        "Homepage": "https://github.com/gmatrixuniverse/chain_index"
    },
    "split_keywords": [
        "web3",
        " ethereum",
        " blockchain",
        " evm"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0e6a64daa910201fce1d6bc622cf2437dae5a09be8aae0d3ddd4fb52f0580387",
                "md5": "24001c3df8fafff95ab2970aed0d3c03",
                "sha256": "1c9dc06640845237e5a2acb88d44846a833c21f87ee4970cc65bd582a594b1b9"
            },
            "downloads": -1,
            "filename": "chain_index-0.2.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "24001c3df8fafff95ab2970aed0d3c03",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 142971,
            "upload_time": "2024-12-28T18:09:28",
            "upload_time_iso_8601": "2024-12-28T18:09:28.628630Z",
            "url": "https://files.pythonhosted.org/packages/0e/6a/64daa910201fce1d6bc622cf2437dae5a09be8aae0d3ddd4fb52f0580387/chain_index-0.2.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "45b2909ce6314017fd25dee6a10e5da11eef63008dc8c11c608987dbf4bd5d96",
                "md5": "b4b5f9a06cdbe8050d675ac362963e68",
                "sha256": "665c7a0a1fe8e820557bee48be4e6fc54ee1b7e1b6f2a8a21a5a2704f2dff27d"
            },
            "downloads": -1,
            "filename": "chain-index-0.2.5.tar.gz",
            "has_sig": false,
            "md5_digest": "b4b5f9a06cdbe8050d675ac362963e68",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 138243,
            "upload_time": "2024-12-28T18:09:32",
            "upload_time_iso_8601": "2024-12-28T18:09:32.020108Z",
            "url": "https://files.pythonhosted.org/packages/45/b2/909ce6314017fd25dee6a10e5da11eef63008dc8c11c608987dbf4bd5d96/chain-index-0.2.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-28 18:09:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "gmatrixuniverse",
    "github_project": "chain_index",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "pydantic",
            "specs": [
                [
                    ">=",
                    "1.8.0"
                ]
            ]
        },
        {
            "name": "typing-extensions",
            "specs": [
                [
                    ">=",
                    "3.7.4"
                ]
            ]
        }
    ],
    "lcname": "chain-index"
}
        
Elapsed time: 9.45626s