Metadata-Version: 2.4
Name: cf_proxy
Version: 0.2.0
Summary: Python package utilizing Cloudflare Workers to proxy requests
Project-URL: Source, https://github.com/kevintsoii/cf_proxy
Author-email: kevintsoii <kevin.tsoi44@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Kevin Tsoi
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: httpx>=0.24.0
Description-Content-Type: text/markdown

# cf_proxy

Python package utilizing Cloudflare Workers to proxy requests

## Prerequisites
- Python 3.8+
- Node.js
- Cloudflare account (100k request/day free)

## Setup (Cloudflare)

1. Deploy the Cloudflare worker
   ```bash
   cd worker
   npx wrangler@latest deploy
   ```

2. Grab your worker URL
   After successful deployment, Wrangler will output your worker URL. It will look like:
   ```
   https://cf_proxy.<username>.workers.dev
   ```

## Getting Started

1. Install the package
   ```
   pip install cf-proxy
   ```

2. Run an [example](https://github.com/kevintsoii/cf_proxy/tree/main/example)
   ```
   pip install httpx
   cd example
   python sync_example.py
   ```

