diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 8e4c26b..a88828a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,2 @@ -# Change Log - -All notable changes to the "solidity-python" extension pack will be documented in this file. - -Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file. - -## [Unreleased] - -- Initial release +## 0.1.0 +- Initial release \ No newline at end of file diff --git a/README.md b/README.md index 77d3bb3..d78010d 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,22 @@ -# solidity-python README +# Solidity Python Extension Pack -## Working with Markdown +The Solidity Python Extension Pack is the ultimate toolkit for Solidity and Python developers working on blockchain projects. This carefully curated collection of extensions empowers you to effortlessly code, test, and deploy smart contracts using Solidity, while leveraging the power of Python. -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: +## Extensions Included -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux). -* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux). -* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets. +- **[Solidity](https://marketplace.cursorapi.com/items?itemName=AckeeBlockchain.tools-for-solidity)**: Advanced Solidity support and vulnerability detectors developed by Ackee Blockchain. +- **[Python](https://marketplace.cursorapi.com/items?itemName=ms-python.python)**: Get full Python language support, including IntelliSense, linting, debugging, and more. +- **[Pylance](https://marketplace.cursorapi.com/items?itemName=ms-python.vscode-pylance)**: Enhance your Python experience with fast and feature-rich language support, powered by Pylance. +- **[isort](https://marketplace.cursorapi.com/items?itemName=ms-python.isort)**: Automatically sort your Python imports to keep your code clean and organized. +- **[autopep8](https://marketplace.cursorapi.com/items?itemName=ms-python.autopep8)**: Automatically format your Python code to adhere to the PEP 8 style guide. +- **[Python Indent](https://marketplace.cursorapi.com/items?itemName=KevinRose.vsc-python-indent)**: Maintain consistent indentation in your Python code with smart indentation handling. +- **[Even Better TOML](https://marketplace.cursorapi.com/items?itemName=tamasfe.even-better-toml)**: Enjoy improved syntax highlighting and validation for TOML files, commonly used for configuration. -## For more information +## Testing Solidity with Python using Wake -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) +One of the key features of this extension pack is the seamless integration with the [Wake](https://getwake.io) tool by Ackee Blockchain. Wake allows you to write Solidity tests using Python, enabling you to leverage the full power of Python for both unit and fuzz tests. Testing Solidity code with Python is easy and quick, and enables powerfull features such as differential testing. -**Enjoy!** +## Contributing + +Want to see an extension added? +Fork the repository, update the `package.json` and `README.md` files with your suggested extension, and create a PR. We will be happy to take a look! \ No newline at end of file diff --git a/package.json b/package.json index ad953a7..5a9b5ee 100644 --- a/package.json +++ b/package.json @@ -13,6 +13,10 @@ "testing", "development" ], + "repository": { + "type": "git", + "url": "https://github.com/Ackee-Blockchain/solidity-python-extension-pack.git" + }, "engines": { "vscode": "^1.92.0" },