/python-blockchain-explorer

Super simple Blockchain explorer for my other project https://github.com/ock666/python-blockchain

Primary LanguagePythonMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Python Blockchain Explorer

A block explorer coded in python, built with flask and requests.
Explore the docs »

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. API
  5. Features
  6. Roadmap
  7. Contributing
  8. License
  9. Contact
  10. Acknowledgments

About The Project

A blockchain explorer written in python which is meant to interface with my other project Python Blockchain

Here's why:

  • To provide a front-end to more easily view the chain data
  • For fun and learning
  • because I have no friends

(back to top)

Built With

(back to top)

Getting Started

Be sure to read this readme in full before trying to get set up or submitting any issues to the repo.

Prerequisites

Install the requirements with

  • pip 
    pip install -r requirements.txt

Installation

  1. Clone the repo 
    git clone https://github.com/ock666/python-blockchain-explorer.git
  2. Install the requirements 
    pip install -r requirements.txt
  3. Run explorer.py to start the webpage. 
    python3 explorer.py

(back to top)

Usage

  • Start the block explorer with:
python3 explorer.py

  • Provide the address of a blockchain node to the explorer.py CLI

  • Navigate to 127.0.0.1:5000 or $your_local_IP_address:5000

  • The web interface should load immediately, if not check the console window for any errors.

(back to top)

Features

Search

search the chain for block index, transaction hash, or public address to see details of the requested information.

Block View

View block data including transactions in blocks.

Address View

View details pertaining to an address on the chain, including sent and received transactions, and balance.

Transaction View

View transaction data.

(back to top)

Roadmap

  • Create templates for block, address, and transaction views.
  • Write functions to return chain data.
  • Implement CSS styling.
  • Come up with some more ideas for the roadmap.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this project better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - Oskar Petersen - oskargjerlevpetersen@gmail.com

Project Link: https://github.com/ock666/python-blockchain-explorer

(back to top)

Acknowledgments

(back to top)