Metadata-Version: 2.4
Name: xcrawl-actor
Version: 0.1.1
Summary: Python SDK for building and running Xcrawl Actors.
Author: Xcrawl
Project-URL: Homepage, https://gitee.com/youquinc/xcrawlactorsdk
Project-URL: Repository, https://gitee.com/youquinc/xcrawlactorsdk.git
Project-URL: Issues, https://gitee.com/youquinc/xcrawlactorsdk/issues
Keywords: xcrawl,actor,sdk,crawler,crawlee
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: crawlee<2,>=1.7.0
Requires-Dist: httpx<0.29,>=0.28.1
Requires-Dist: lazy-object-proxy<2,>=1.12.0
Requires-Dist: pydantic<3,>=2.13.4
Requires-Dist: requests<3,>=2.34.2
Requires-Dist: typing-extensions<5,>=4.15.0
Requires-Dist: yarl<2,>=1.24.2
Provides-Extra: dev
Requires-Dist: build>=1.2.2; extra == "dev"
Requires-Dist: ipython<9,>=8.12.3; extra == "dev"
Requires-Dist: pytest<10,>=9.0.3; extra == "dev"
Requires-Dist: twine>=6.1.0; extra == "dev"

# xcrawl-actor

`xcrawl-actor` is a Python SDK for building and running Xcrawl Actor workloads.

## Install

```bash
pip install xcrawl-actor
```

## Import

```python
from xcrawl_actor import Actor
```

The distribution name on PyPI uses a hyphen, but the Python import path uses an underscore.  
`from xcrawl-actor import Actor` is not valid Python syntax.

## Quick Start

```python
from xcrawl_actor import Actor


async def main() -> None:
    async with Actor:
        Actor.log.info("xcrawl actor started")


if __name__ == "__main__":
    import asyncio

    asyncio.run(main())
```

## Development Install

```bash
pip install -e .[dev]
```

## Build And Publish

```bash
python -m pip install --upgrade build twine
python -m build
python -m twine check dist/*
python -m twine upload dist/*
```

## Package Layout

- `xcrawl_actor/`: runtime package exported to users.
- `pyproject.toml`: PyPI metadata and build configuration.
- `MANIFEST.in`: source distribution include rules.

## Repository

- Homepage: `https://gitee.com/youquinc/xcrawlactorsdk`
- Repository: `https://gitee.com/youquinc/xcrawlactorsdk.git`
