Metadata-Version: 2.4
Name: affx
Version: 1.1
Summary: API client for automating affiliate website generation and updates.
Author: affx
License: Proprietary
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: supabase
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# affx

`affx` is a Python client for automating the generation, update, and management of affiliate websites through the affx API service.

It lets users install a package with `pip` and use affx from Python while the main service logic runs through the affx API.

## Installation

```bash
pip install affx
```

## Official Links

- Official Website: https://affx.ai
- API Service: https://api.affx.ai

## Quick Start

```python
import affx

affx.key = "your_api_key"
affx.help()
```

## Example Calls

```python
import affx

affx.key = "your_api_key"

affx.ls("site")
affx.gen("schema", domain="example.com", path="about")
affx.dl("page", domain="example.com", path="about")
```

## Important Notes

- Set `affx.key` before calling features that require authentication.
- Some features may take longer to complete because they depend on remote services.
- Users may need to upgrade the package to receive new client-side functions:

```bash
pip install --upgrade affx
```

## Main Functions

- `affx.gen(...)`
- `affx.upd(...)`
- `affx.rm(...)`
- `affx.ls(...)`
- `affx.dl(...)`
- `affx.set(...)`
- `affx.help()`
- `affx.feedback(...)`

## Requirements

- Python 3.9+
- Internet access for remote API features

## Support

If a feature returns an error, first confirm:

- your API key is set correctly
- your network is available
- the remote affx service is reachable

## License

This project is distributed under a proprietary closed-source license owned by AffX.ai.
