Skip to content
This repository has been archived by the owner on Nov 15, 2021. It is now read-only.

Updating development version #1023

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open
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
46 changes: 22 additions & 24 deletions docs/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,35 @@
Overview
========

What does it currently do
^^^^^^^^^^^^^^^^^^^^^^^^^

- This project aims to be a full port of the original C# `NEO project <https://github.com/neo-project>`_
- Run a Python based P2P node
- Interactive CLI for configuring node and inspecting blockchain
- Compile, test, deploy and run Smart Contracts written in python or any Smart Contract in the ``.avm`` format
- `NEP2 <https://github.com/neo-project/proposals/blob/master/nep-2.mediawiki>`_ and `NEP5 <https://github.com/neo-project/proposals/blob/master/nep-5.mediawiki>`_ compliant wallet functionality
- RPC Client
- RPC server
- Notification Server ( for viewing transfers of NEP5 tokens )
- ``Runtime.Log`` and ``Runtime.Notify`` event monitoring

What will it do
^^^^^^^^^^^^^^^
Neo-python is an implementation of the Neo protocol using Python.


What it currently does
^^^^^^^^^^^^^^^^^^^^^^

- Consensus nodes
- Full smart contract debugging and inspection
- A Command Line Interface (CLI) for node configuration and blockchain inspection.
- Smart Contracts development tool using `neo-boa <https://github.com/CityOfZion/neo-boa>`_, debugging and deployment using the command line.
- `RPC Client <https://github.com/CityOfZion/neo-python-rpc>`_ and RPC Server.
- Notification server with optional REST endpoints (for viewing transfers of NEP5 tokens).
- ``Runtime.Log`` and ``Runtime.Notify`` event monitoring.
- `NEP2 <https://github.com/neo-project/proposals/blob/master/nep-2.mediawiki>`_ and `NEP5 <https://github.com/neo-project/proposals/blob/master/nep-5.mediawiki>`_ compliant wallet.
- This project aimed to be an alternative implementation for the original C# `NEO
project <https://github.com/neo-project>`_.


Neo 3
^^^^^
Our current focus is on Neo 3, with neo-python (Neo 2) only receiving the necessary bug fixes.


Getting started
^^^^^^^^^^^^^^^
Please follow directions in `the install section <install.html>`_
Please follow directions in `the install section <install.html>`_.

The main functionality for this project is contained within the cli application ``np-prompt``. You can `view usage details here <prompt.html>`_
The main functionality for this project is contained within the cli application ``np-prompt``. You can `view usage details here <prompt.html>`_.

We have published a Youtube `video <https://youtu.be/oy6Z_zd42-4>`_ to help get you started with this library. There are other videos under the `CityOfZion <(https://www.youtube.com/channel/UCzlQUNLrRa8qJkz40G91iJg>`_ Youtube channel.

Watch this `video <https://youtu.be/oy6Z_zd42-4>`_ to help get you started.

Sister projects
^^^^^^^^^^^^^^^
Visit `CityOfZion <https://www.youtube.com/channel/UCzlQUNLrRa8qJkz40G91iJg>`_ for more video tutorials.

- `neo-python-rpc <https://github.com/CityOfZion/neo-python-rpc>`_: NEO RPC client in Python
- `neo-boa <https://github.com/CityOfZion/neo-boa>`_: Write smart contracts with Python