Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ai-mindset/py-cross-compile
Automated Python-to-binary compiler for Windows, macOS, and Linux, using PyInstaller and GitHub Actions.
https://github.com/ai-mindset/py-cross-compile
cross-compile github-actions linux macos pyinstaller unix windows
Last synced: 18 days ago
JSON representation
Automated Python-to-binary compiler for Windows, macOS, and Linux, using PyInstaller and GitHub Actions.
- Host: GitHub
- URL: https://github.com/ai-mindset/py-cross-compile
- Owner: ai-mindset
- License: mit
- Created: 2024-11-02T09:29:24.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-10T16:05:35.000Z (3 months ago)
- Last Synced: 2024-11-18T03:04:55.532Z (3 months ago)
- Topics: cross-compile, github-actions, linux, macos, pyinstaller, unix, windows
- Language: Python
- Homepage:
- Size: 102 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PDF to Markdown Converter
[](https://github.com/ai-mindset/py-cross-compile/actions/workflows/code-quality.yml)
[](https://github.com/ai-mindset/py-cross-compile/actions/workflows/tests.yml)
[](https://github.com/ai-mindset/py-cross-compile/actions/workflows/unix-build.yml)
[](https://github.com/ai-mindset/py-cross-compile/actions/workflows/win-build.yml)
[](https://github.com/astral-sh/ruff)
A GUI application for converting PDF documents to Markdown using pypdf. This project primarily serves as an experiment in cross-compilation using GitHub Actions, demonstrating how to build Python applications for multiple platforms from a single Linux environment.
## Project Goals
1. **Cross-Compilation Experimentation**
- Build from Linux for Windows, macOS, and Linux targets
- Support both x86_64 and ARM64 architectures
- Create self-contained executables without target OS access
- Handle dependencies and resources across platforms
- Automate the release process
2. **Technical Implementation**
- Modern Python practices (3.11+)
- Type-safe code with comprehensive testing
- Memory-efficient PDF processing
- User-friendly GUI interface
## Features
- Cross-platform PDF to Markdown conversion
- Table extraction in fast and accurate modes
- Memory-efficient processing
- Simple, native-looking GUI
- Self-contained executables
## Requirements
- Python 3.11 or newer
- Operating System: Windows, macOS, or Linux
## Installation
### End Users
Download the appropriate executable for your system from the [Releases](https://github.com/ai-mindset/py-cross-compile/releases) page:
- Windows: `pdf-converter-windows-x86_64.exe`
- macOS:
- Intel: `pdf-converter-macos-x86_64`
- Apple Silicon: `pdf-converter-macos-arm64`
- Linux:
- x86_64: `pdf-converter-linux-x86_64`
- ARM64: `pdf-converter-linux-aarch64`
### Developers
1. Clone the repository:
```bash
git clone https://github.com/ai-mindset/py-cross-compile.git
cd py-cross-compile
```
2. Create a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
```
3. Install dependencies:
```bash
pip install -e ".[dev]"
```
## Development
### Code Quality
```bash
# Format and lint code
ruff check .
ruff format .
# Type checking
mypy src
```
### Testing
```bash
pytest
```
### Creating a Release
1. Update version in `pyproject.toml`
2. Update CHANGELOG.md
3. Create and push a new tag:
```bash
git tag v1.0.0
git push origin v1.0.0
```
The GitHub Action will automatically:
- Run tests
- Build executables for all platforms
- Create a new release with the binaries
## Project Structure
```
pdf_converter/
├── src/
│ └── pdf_converter/
│ ├── __init__.py
│ ├── app.py
│ └── resources/
│ └── .gitkeep
├── tests/
│ ├── __init__.py
│ └── test_app.py
├── .github/
│ └── workflows/
│ ├── code-quality.yml
│ ├── tests.yml
│ ├── win-build.yml
│ └── unix-build.yml
├── .gitignore
├── LICENSE
├── pyproject.toml
└── README.md
```
## Cross-Compilation Details
### Build Process
- Uses GitHub Actions with Ubuntu runners
- Leverages QEMU for ARM64 builds
- PyInstaller for executable creation
- Automated resource bundling
### Supported Platforms
- Windows (x86_64)
- macOS (x86_64, ARM64)
- Linux (x86_64, ARM64)
### CI/CD Pipeline
1. **Code Quality** (`code-quality.yml`)
- Ruff (linting and formatting)
- MyPy (type checking)
- Security checks (disabled for now)
2. **Tests** (`tests.yml`)
- Multiple Python versions
- Multiple operating systems
- Coverage reporting
3. **Unix Build & Release** (`unix-build.yml`)
- MacOS and Linux x86-64 and ARM builds
- Automatic releases on tags
- Asset uploading
4. **Windows Build & Release** (`win-build.yml`)
- Windows x86_64 builds
- Automatic releases on tags
- Asset uploading
## Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Run quality checks:
```bash
ruff check . && ruff format . && mypy src && pytest
```
4. Commit your changes (`git commit -m 'Add amazing feature'`)
5. Push to the branch (`git push origin feature/amazing-feature`)
6. Create a Pull Request
## License
MIT License - see [`LICENSE`](LICENSE) for details.