# Meter-gear
Proxy [Meter](https://github.com/meterio/meter-pos)'s RESTful API to Eth JSON-RPC, to support Remix, Truffle and more (You should give priority to using Meter's RESTful API).
# Quick Start
## Installation
### On OS X
* Python 3.8+ support
1. Install the system-dependecies
```
brew install openssl
export CFLAGS="-I$(brew --prefix openssl)/include $CFLAGS"
export LDFLAGS="-L$(brew --prefix openssl)/lib $LDFLAGS"
```
2. Installation of Meter-Gear and it's dependent Python packages via PyPI
```
pip3 install meter-gear
```
### On Ubuntu
* Python 3.8+ support
1. Install the system-dependecies
```
sudo apt-get install build-essential libssl-dev python-dev
```
2. Use a virtual environment to isolate your meter-gear project
```
python3 -m venv meter-venv
source meter-venv/bin/activate
```
3. Installation of Meter-Gear and it's dependent Python packages via PyPI
```
pip3 install meter-gear
```
Note that you can activate and deactivate your virtual environment now
```
source meter-venv/bin/activate
deactivate
```
See https://docs.python.org/3/library/venv.html for more information
### On Windows
* Python 3.8+ support
1. Install Visual C++ Build Tools.
2. Install [scrypt-py](https://pypi.org/project/scrypt/#files) use the precompiled wheels.
3. Installation of Meter-Gear and it's dependent Python packages via PyPI
```
pip3 install meter-gear
```
## Run
Installing through pip will make the ``meter-gear`` command available on your machine (`must run meter client first.`)
```
meter-gear
```
This will run meter-gear on `127.0.0.1:8545`.
You can change its default behavior with the following parameters:
- **host**: rpc service host, eg: `--host 127.0.0.1`
- **port**: rpc service port, eg: `--port 8545`
- **endpoint**: meter restful service endpoint, eg: `--endpoint http://127.0.0.1:8669`
- **keystore**: keystore file path, eg: `--keystore /Users/(username)/keystore)`, default=meter stand-alone(solo) built-in accounts
- **passcode**: passcode of keystore, eg: `--passcode xxxxxxxx`
- **debug**: bool default=false, whether to display debug logs, eg: `--debug true`
- **log**: bool default=false, whether to display rpc logs, eg: `--log false`
### Use Remix
Change the Remix environment to Web3 provide.
### Use Truffle
* Truffle 4.0.6+ support
Modify the configuration of truffle first(`truffle.js`):
```js
module.exports = {
networks: {
development: {
host: "localhost",
port: 8545,
network_id: "*" // Match any network id
}
}
};
```
Then you can use truffle's command line tool.
Raw data
{
"_id": null,
"home_page": "https://github.com/meterio/meter-gear",
"name": "meter-gear",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "meter blockchain ethereum",
"author": "Simon Zhang",
"author_email": "zhanghan.simon@gmail.com",
"download_url": null,
"platform": null,
"description": "# Meter-gear\n\nProxy [Meter](https://github.com/meterio/meter-pos)'s RESTful API to Eth JSON-RPC, to support Remix, Truffle and more (You should give priority to using Meter's RESTful API).\n\n# Quick Start\n\n## Installation\n\n### On OS X\n\n* Python 3.8+ support\n\n1. Install the system-dependecies\n\n ```\n brew install openssl\n export CFLAGS=\"-I$(brew --prefix openssl)/include $CFLAGS\"\n export LDFLAGS=\"-L$(brew --prefix openssl)/lib $LDFLAGS\"\n ```\n\n2. Installation of Meter-Gear and it's dependent Python packages via PyPI\n\n ```\n pip3 install meter-gear\n ```\n\n### On Ubuntu\n\n* Python 3.8+ support\n\n1. Install the system-dependecies\n\n ```\n sudo apt-get install build-essential libssl-dev python-dev\n ```\n\n2. Use a virtual environment to isolate your meter-gear project\n\n ```\n python3 -m venv meter-venv\n source meter-venv/bin/activate\n ```\n\n3. Installation of Meter-Gear and it's dependent Python packages via PyPI\n\n ```\n pip3 install meter-gear\n ```\n\nNote that you can activate and deactivate your virtual environment now\n\n```\nsource meter-venv/bin/activate\ndeactivate\n```\n\nSee https://docs.python.org/3/library/venv.html for more information\n\n### On Windows\n\n* Python 3.8+ support\n\n1. Install Visual C++ Build Tools.\n\n2. Install [scrypt-py](https://pypi.org/project/scrypt/#files) use the precompiled wheels.\n\n3. Installation of Meter-Gear and it's dependent Python packages via PyPI\n\n ```\n pip3 install meter-gear\n ```\n\n## Run\n\nInstalling through pip will make the ``meter-gear`` command available on your machine (`must run meter client first.`)\n\n```\nmeter-gear\n```\n\nThis will run meter-gear on `127.0.0.1:8545`.\n\nYou can change its default behavior with the following parameters:\n\n- **host**: rpc service host, eg: `--host 127.0.0.1`\n- **port**: rpc service port, eg: `--port 8545`\n- **endpoint**: meter restful service endpoint, eg: `--endpoint http://127.0.0.1:8669`\n- **keystore**: keystore file path, eg: `--keystore /Users/(username)/keystore)`, default=meter stand-alone(solo) built-in accounts\n- **passcode**: passcode of keystore, eg: `--passcode xxxxxxxx`\n- **debug**: bool default=false, whether to display debug logs, eg: `--debug true`\n- **log**: bool default=false, whether to display rpc logs, eg: `--log false`\n\n### Use Remix\n\nChange the Remix environment to Web3 provide.\n\n\n\n### Use Truffle\n\n* Truffle 4.0.6+ support\n\nModify the configuration of truffle first(`truffle.js`):\n\n```js\nmodule.exports = {\n networks: {\n development: {\n host: \"localhost\",\n port: 8545,\n network_id: \"*\" // Match any network id\n }\n }\n};\n```\n\nThen you can use truffle's command line tool.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An adapter between meter-restful and eth-rpc.",
"version": "1.2.92",
"project_urls": {
"Homepage": "https://github.com/meterio/meter-gear"
},
"split_keywords": [
"meter",
"blockchain",
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d3c9a9f50d857238c5e3532a6db63294eda20a9b42e93e569089020c1a428e6",
"md5": "d4d20bcc077c1793bfc2d3bd1ebfeee4",
"sha256": "b10ff76da0832a6334613683166ebbf43cb0e15b387e65be63a7e941ad801c25"
},
"downloads": -1,
"filename": "meter_gear-1.2.92-py39-none-any.whl",
"has_sig": false,
"md5_digest": "d4d20bcc077c1793bfc2d3bd1ebfeee4",
"packagetype": "bdist_wheel",
"python_version": "py39",
"requires_python": ">=3.9",
"size": 26958,
"upload_time": "2024-07-02T17:36:32",
"upload_time_iso_8601": "2024-07-02T17:36:32.380511Z",
"url": "https://files.pythonhosted.org/packages/9d/3c/9a9f50d857238c5e3532a6db63294eda20a9b42e93e569089020c1a428e6/meter_gear-1.2.92-py39-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-02 17:36:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "meterio",
"github_project": "meter-gear",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"circle": true,
"requirements": [],
"lcname": "meter-gear"
}
JSON
