Metadata-Version: 2.1
Name: pyvsystems-rewards
Version: 0.0.2
Summary: A library for calculating v.systems Supernode Rewards
Home-page: https://github.com/belovachap/pyvsystems_rewards
Author: Chapman Shoop
Author-email: chapman.shoop@gmail.com
License: UNKNOWN
Description: # pyvsystems_rewards
        
        This library provides the accounting required to operate a successful and
        transparent VSystems Supernode.
        
        ## Quick Start
        
        The library is still in "alpha" but is being used to generate the automated
        reporting for [Peercoin's VPool](https://forum.v.systems/t/introducing-peercoin-vpool-to-the-vsys-community/173)
        at http://vsys.peercoin-library.org/.
        
        The library will be made available through pip in the coming weeks but can be
        used sooner:
        
        1. `git clone https://github.com/belovachap/pyvsystems_rewards.git`
        2. `cd pyvsystems_rewards`
        3. `virtualenv -p python3 venv`
        4. `source venv/bin/activate`
        5. `pip install -r requirements.txt`
        6. `pip install -r requirements-dev.txt`
        
        In `reports.py` update the following settings to reflect your Supernode's
        attributes:
        
        ```python
            hot_wallet_address = 'AR6Gt6GXq7yPnXoFek83sQ6sCekQWbBj7YK'
            cold_wallet_address = 'ARMb6m8PLr45oGAooYzYnxb8cSC112B7KCp'
            operation_fee_percent = Decimal('0.18')
        ```
        
        Then run `./reports.py` and open `html_output/index.html` in a web browser to
        check on the status of your Supernode's interest and distributions.
        
        Unit tests can be run with `pytest test`.
        
        ## Future Work
        
        * Make library available through pip.
        * Move reporting scripts to their own repository.
        * Move distribution scripts to their own repository.
        * Write unit tests that consume real world data and produce vetted results.
        * Release a 0.1.0 version.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
