Metadata-Version: 2.1
Name: nimiqclient
Version: 0.1.2
Summary: A python client for the Nimiq JSON-RPC API
Home-page: https://github.com/nimiq-community/python-client
Author: The Nimiq Foundation
Author-email: info@nimiq.com
License: Apache 2.0
Description: # Nimiq Python Client
        
        > Python implementation of the Nimiq RPC client specs.
        
        ## Usage
        
        To get started sending requests to a Nimiq node, we create a `NimiqClient` object.
        
        ```python
        import nimiqclient
        
        client = NimiqClient(
        	scheme = "http",
        	user = "luna",
        	password = "moon",
        	host = "127.0.0.1",
        	port = 8648
        )
        
        # make rpc call to get current block number
        blockNumber = client.blockNumber()
        print(blockNumber)
        ```
        
        Note: When no `config` object is passed in the initialization it will use the default values in the Nimiq node.
        
        ## API
        
        The complete API documentation is available [here](https://nimiq-community.github.io/python-client/).
        
        Check out the original [Nimiq RPC specs](https://github.com/nimiq/core-js/wiki/JSON-RPC-API) for the behind-the-scenes RPC calls.
        
        ## Installation
        
        Using PIP
        
        ```sh
        pip install nimiqclient
        ```
        
        Or clone the repository and install the package from source
        
        ```sh
        git clone https://github.com/nimiq-community/python-client
        cd python-client
        python setup.py install
        ```
        
        ## Build
        
        Clone the repo and install it
        
        ```sh
        git clone https://github.com/nimiq-community/python-client
        cd python-client
        python setup.py install
        ```
        
        All done, happy coding!
        
        ## Test
        
        You need a start a Testnet Nimiq node:
        
        ```sh
        nodejs index.js --protocol=dumb --type=full --network=test --rpc
        ```
        
        Tests are stored in the `/tests` folder and can be run from the command line like this:
        
        ```sh
        python -m unittest discover -v
        ```
        
        ## Documentation
        
        The documentation is generated automatically with [Sphinx](https://www.sphinx-doc.org).
        
        From the repository root directory install the development dependency requirements:
        
        ```sh
        pip install -r requirements-dev.txt
        ```
        
        Then from the `/docs` directory run Sphinx via the `make` command:
        
        ```sh
        cd docs
        make html
        ```
        
        Add a blank file in the `/docs` folder with the name `.nojekyll` for the documentation hosted on GitHub Pages:
        
        ```sh
        touch .nojekyll
        ```
        
        ## Contributions
        
        This implementation was originally contributed by [rraallvv](https://github.com/rraallvv/).
        
        Bug reports and pull requests are welcome! Please refer to the [issue tracker](https://github.com/nimiq-community/python-client/issues) for ideas.
        
        ## License
        
        [Apache 2.0](LICENSE.md)
        
Platform: UNKNOWN
Requires-Python: >=2.4
Description-Content-Type: text/markdown
