# py-solc-x
[![Pypi Status](https://img.shields.io/pypi/v/py-solc-x.svg)](https://pypi.org/project/py-solc-x/) [![Build Status](https://img.shields.io/github/workflow/status/iamdefinitelyahuman/py-solc-x/py-solc-x%20workflow)](https://github.com/iamdefinitelyahuman/py-solc-x/actions) [![Coverage Status](https://img.shields.io/codecov/c/github/iamdefinitelyahuman/py-solc-x)](https://codecov.io/gh/iamdefinitelyahuman/py-solc-x)
Python wrapper and version management tool for the `solc` Solidity compiler.
Forked from [`py-solc`](https://github.com/ethereum/py-solc).
## Features
- Full support for Solidity `>=0.4.11`
- Install Solidity on Linux, OSX and Windows
- Compile Solidity from source on Linux and OSX
## Dependencies
Py-solc-x allows the use of multiple versions of solc, and can install or compile them as needed. If you wish to compile from source you must first insall the required [solc dependencies](https://solidity.readthedocs.io/en/latest/installing-solidity.html#building-from-source).
## Installation
### via `pip`
```bash
pip install py-solc-x
```
### via `setuptools`
```bash
git clone https://github.com/iamdefinitelyahuman/py-solc-x.git
cd py-solc-x
python3 setup.py install
```
## Documentation
Documentation is hosted at [Read the Docs](https://solcx.readthedocs.io/en/latest/).
## Testing
Py-solc-x is tested on Linux, OSX and Windows with solc versions `>=0.4.11`.
To run the test suite:
```bash
pytest tests/
```
By default, the test suite installs all available `solc` versions for your OS. If you only wish to test against already installed versions, include the `--no-install` flag.
## Contributing
Help is always appreciated! Feel free to open an issue if you find a problem, or a pull request if you've solved an issue.
Please check out our [Contribution Guide](CONTRIBUTING.md) prior to opening a pull request, and join the Brownie [Gitter channel](https://gitter.im/eth-brownie/community) if you have any questions.
## License
This project is licensed under the [MIT license](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/ApeWorX/py-solc-x",
"name": "py-solc-x",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "ethereum solidity solc",
"author": "ApeWorX Ltd.",
"author_email": "admin@apeworx.io",
"download_url": "https://files.pythonhosted.org/packages/2a/42/60f33a2d32b1308656b9f1e49a478ea81e294d9aaba4404f83dc20e1d60e/py-solc-x-2.0.3.tar.gz",
"platform": null,
"description": "# py-solc-x\n\n[![Pypi Status](https://img.shields.io/pypi/v/py-solc-x.svg)](https://pypi.org/project/py-solc-x/) [![Build Status](https://img.shields.io/github/workflow/status/iamdefinitelyahuman/py-solc-x/py-solc-x%20workflow)](https://github.com/iamdefinitelyahuman/py-solc-x/actions) [![Coverage Status](https://img.shields.io/codecov/c/github/iamdefinitelyahuman/py-solc-x)](https://codecov.io/gh/iamdefinitelyahuman/py-solc-x)\n\nPython wrapper and version management tool for the `solc` Solidity compiler.\n\nForked from [`py-solc`](https://github.com/ethereum/py-solc).\n\n## Features\n\n- Full support for Solidity `>=0.4.11`\n- Install Solidity on Linux, OSX and Windows\n- Compile Solidity from source on Linux and OSX\n\n## Dependencies\n\nPy-solc-x allows the use of multiple versions of solc, and can install or compile them as needed. If you wish to compile from source you must first insall the required [solc dependencies](https://solidity.readthedocs.io/en/latest/installing-solidity.html#building-from-source).\n\n## Installation\n\n### via `pip`\n\n```bash\npip install py-solc-x\n```\n\n### via `setuptools`\n\n```bash\ngit clone https://github.com/iamdefinitelyahuman/py-solc-x.git\ncd py-solc-x\npython3 setup.py install\n```\n\n## Documentation\n\nDocumentation is hosted at [Read the Docs](https://solcx.readthedocs.io/en/latest/).\n\n## Testing\n\nPy-solc-x is tested on Linux, OSX and Windows with solc versions `>=0.4.11`.\n\nTo run the test suite:\n\n```bash\npytest tests/\n```\n\nBy default, the test suite installs all available `solc` versions for your OS. If you only wish to test against already installed versions, include the `--no-install` flag.\n\n## Contributing\n\nHelp is always appreciated! Feel free to open an issue if you find a problem, or a pull request if you've solved an issue.\n\nPlease check out our [Contribution Guide](CONTRIBUTING.md) prior to opening a pull request, and join the Brownie [Gitter channel](https://gitter.im/eth-brownie/community) if you have any questions.\n\n## License\n\nThis project is licensed under the [MIT license](LICENSE).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python wrapper and version management tool for the solc Solidity compiler.",
"version": "2.0.3",
"project_urls": {
"Homepage": "https://github.com/ApeWorX/py-solc-x"
},
"split_keywords": [
"ethereum",
"solidity",
"solc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d30c2075d568e3cef46947089a07878cf8da1dde4e0c8a566e9b04c1ea0fec6",
"md5": "ffc79651a8b91c351f4a8c3d67b66321",
"sha256": "ef131f2f0e708fcaf92068a38c7569920839d259fdaa9946af3393f1dc86c5b1"
},
"downloads": -1,
"filename": "py_solc_x-2.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ffc79651a8b91c351f4a8c3d67b66321",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 18532,
"upload_time": "2024-05-20T14:42:56",
"upload_time_iso_8601": "2024-05-20T14:42:56.420639Z",
"url": "https://files.pythonhosted.org/packages/9d/30/c2075d568e3cef46947089a07878cf8da1dde4e0c8a566e9b04c1ea0fec6/py_solc_x-2.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2a4260f33a2d32b1308656b9f1e49a478ea81e294d9aaba4404f83dc20e1d60e",
"md5": "0cd1e6ed6c18a600024b9b2b40a366d9",
"sha256": "1b5fe26d5f4976b1fcc2b3276fb2fe182633bc35757a3abf3b9af5ac57ec2544"
},
"downloads": -1,
"filename": "py-solc-x-2.0.3.tar.gz",
"has_sig": false,
"md5_digest": "0cd1e6ed6c18a600024b9b2b40a366d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 77698,
"upload_time": "2024-05-20T14:42:58",
"upload_time_iso_8601": "2024-05-20T14:42:58.096110Z",
"url": "https://files.pythonhosted.org/packages/2a/42/60f33a2d32b1308656b9f1e49a478ea81e294d9aaba4404f83dc20e1d60e/py-solc-x-2.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-20 14:42:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ApeWorX",
"github_project": "py-solc-x",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "py-solc-x"
}