| Name | xify JSON |
| Version |
2.2.0
JSON |
| download |
| home_page | None |
| Summary | An asynchronous Python client for interacting with the X API. |
| upload_time | 2025-10-06 22:18:38 |
| maintainer | None |
| docs_url | None |
| author | Filming |
| requires_python | >=3.10 |
| license | MIT License
Copyright (c) 2025 Filming
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.
|
| keywords |
api
python
python3
social-media
twitter
x
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Xify
<p align="center">
<a href="https://pypi.org/project/xify/"><img alt="PyPI" src="https://img.shields.io/pypi/v/xify?color=blue"></a>
<a href="https://pypi.org/project/xify/"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/xify"></a>
<a href="https://github.com/filming/xify/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/License--yellow.svg"></a>
</p>
Xify is a Python client for interacting with the X (formerly Twitter) API. This library provides an asynchronous interface to perform common tasks like creating tweets as well as providing authentication and custom error handling.
---
## Features
- **Send Tweets:** Contains functionality to send tweets.
- **OAuth 1.0a Authentication:** Sign and authenticate requests to the X API.
- **Async HTTP Requests:** Uses `aiohttp` for efficient, non-blocking network operations.
- **Developer Experience:** Includes ruff, mypy, pre-commit, and commitizen for high-quality code.
---
## Installation
### From PyPI (Recommended)
```bash
pip install xify
```
### From Source
You can install Xify by cloning the repository directly or using pre-built wheel files.
**Prerequisites:** This project requires [uv](https://github.com/astral-sh/uv) for dependency management.
#### Option 1: Clone and Build
1. Clone the repository:
```bash
git clone https://github.com/filming/xify.git
cd xify
```
2. Install the project and its dependencies:
```bash
uv sync
```
#### Option 2: Install from Pre-built Wheels
Pre-built wheel files are attached to each GitHub release. You can download and install them directly:
1. Go to the [GitHub releases page](https://github.com/filming/xify/releases)
2. Download the `.whl` file from the latest release
3. Install using pip:
```bash
pip install path/to/downloaded/xify-*.whl
```
---
## Usage
Here's a basic example of how to use `Xify` to send out a tweet:
```python
import asyncio
from xify import Xify
async def main():
x_consumer_key = "1111111111"
x_consumer_secret = "2222222222"
x_access_token = "3333333333"
x_access_token_secret = "4444444444"
async with Xify(
x_consumer_key=x_consumer_key,
x_consumer_secret=x_consumer_secret,
x_access_token=x_access_token,
x_access_token_secret=x_access_token_secret,
) as client:
response = await client.tweet({"msg": "hello!"})
if __name__ == "__main__":
asyncio.run(main())
```
---
## Development
This project uses modern Python development tools:
- **[uv](https://github.com/astral-sh/uv)** for dependency management
- **[ruff](https://github.com/astral-sh/ruff)** for linting and formatting
- **[mypy](https://mypy.readthedocs.io/)** for type checking
- **[pre-commit](https://pre-commit.com/)** for git hooks
- **[commitizen](https://commitizen-tools.github.io/commitizen/)** for conventional commits
### Setting up for development:
1. Clone the repository:
```bash
git clone https://github.com/filming/xify.git
cd xify
```
2. Install dependencies (including dev tools):
```bash
uv sync --extra dev
```
3. Set up pre-commit hooks:
```bash
uv run pre-commit install
```
4. Start developing!
---
## Dependencies
All project dependencies are managed via [`pyproject.toml`](pyproject.toml) and use Python 3.10+.
---
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
## Contributing
Contributions, bug reports, and feature requests are welcome!
Please open an issue or submit a pull request on [GitHub](https://github.com/filming/xify).
Raw data
{
"_id": null,
"home_page": null,
"name": "xify",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "api, python, python3, social-media, twitter, x",
"author": "Filming",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/02/ba/07e561fbafbc7a6ab017f05b593008a466518256918ebb436a0c6c726cae/xify-2.2.0.tar.gz",
"platform": null,
"description": "# Xify\n\n<p align=\"center\">\n <a href=\"https://pypi.org/project/xify/\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/xify?color=blue\"></a>\n <a href=\"https://pypi.org/project/xify/\"><img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/xify\"></a>\n <a href=\"https://github.com/filming/xify/blob/main/LICENSE\"><img alt=\"License\" src=\"https://img.shields.io/badge/License--yellow.svg\"></a>\n</p>\n\nXify is a Python client for interacting with the X (formerly Twitter) API. This library provides an asynchronous interface to perform common tasks like creating tweets as well as providing authentication and custom error handling.\n\n---\n\n## Features\n\n- **Send Tweets:** Contains functionality to send tweets. \n- **OAuth 1.0a Authentication:** Sign and authenticate requests to the X API.\n- **Async HTTP Requests:** Uses `aiohttp` for efficient, non-blocking network operations.\n- **Developer Experience:** Includes ruff, mypy, pre-commit, and commitizen for high-quality code.\n\n---\n\n## Installation\n\n### From PyPI (Recommended)\n\n```bash\npip install xify\n```\n\n### From Source\n\nYou can install Xify by cloning the repository directly or using pre-built wheel files.\n\n**Prerequisites:** This project requires [uv](https://github.com/astral-sh/uv) for dependency management.\n\n#### Option 1: Clone and Build\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/filming/xify.git\n cd xify\n ```\n\n2. Install the project and its dependencies:\n ```bash\n uv sync\n ```\n\n#### Option 2: Install from Pre-built Wheels\n\nPre-built wheel files are attached to each GitHub release. You can download and install them directly:\n\n1. Go to the [GitHub releases page](https://github.com/filming/xify/releases)\n2. Download the `.whl` file from the latest release\n3. Install using pip:\n ```bash\n pip install path/to/downloaded/xify-*.whl\n ```\n\n---\n\n## Usage\n\nHere's a basic example of how to use `Xify` to send out a tweet:\n\n```python\nimport asyncio\nfrom xify import Xify\n\nasync def main():\n x_consumer_key = \"1111111111\"\n x_consumer_secret = \"2222222222\"\n x_access_token = \"3333333333\"\n x_access_token_secret = \"4444444444\"\n\n async with Xify(\n x_consumer_key=x_consumer_key,\n x_consumer_secret=x_consumer_secret,\n x_access_token=x_access_token,\n x_access_token_secret=x_access_token_secret,\n ) as client:\n response = await client.tweet({\"msg\": \"hello!\"})\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\n---\n\n## Development\n\nThis project uses modern Python development tools:\n\n- **[uv](https://github.com/astral-sh/uv)** for dependency management\n- **[ruff](https://github.com/astral-sh/ruff)** for linting and formatting \n- **[mypy](https://mypy.readthedocs.io/)** for type checking\n- **[pre-commit](https://pre-commit.com/)** for git hooks\n- **[commitizen](https://commitizen-tools.github.io/commitizen/)** for conventional commits\n\n### Setting up for development:\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/filming/xify.git\n cd xify\n ```\n\n2. Install dependencies (including dev tools):\n ```bash\n uv sync --extra dev\n ```\n\n3. Set up pre-commit hooks:\n ```bash\n uv run pre-commit install\n ```\n \n4. Start developing!\n\n---\n\n## Dependencies\n\nAll project dependencies are managed via [`pyproject.toml`](pyproject.toml) and use Python 3.10+.\n\n---\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n## Contributing\n\nContributions, bug reports, and feature requests are welcome!\nPlease open an issue or submit a pull request on [GitHub](https://github.com/filming/xify).",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Filming\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "An asynchronous Python client for interacting with the X API.",
"version": "2.2.0",
"project_urls": {
"Changelog": "https://github.com/filming/xify/blob/master/CHANGELOG.md",
"Homepage": "https://github.com/filming/xify",
"Issues": "https://github.com/filming/xify/issues",
"Repository": "https://github.com/filming/xify"
},
"split_keywords": [
"api",
" python",
" python3",
" social-media",
" twitter",
" x"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0d449513aa8433ba0510ab676d6021f2971b0dabc64b9aa968164bc4019bbe4e",
"md5": "c5a908925b9de7f91da344e2440c757f",
"sha256": "39ba39055f1654bc51ad5064b5449ee3bc397fedba9def1130a556b2d977ebf0"
},
"downloads": -1,
"filename": "xify-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5a908925b9de7f91da344e2440c757f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 9218,
"upload_time": "2025-10-06T22:18:37",
"upload_time_iso_8601": "2025-10-06T22:18:37.587380Z",
"url": "https://files.pythonhosted.org/packages/0d/44/9513aa8433ba0510ab676d6021f2971b0dabc64b9aa968164bc4019bbe4e/xify-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "02ba07e561fbafbc7a6ab017f05b593008a466518256918ebb436a0c6c726cae",
"md5": "beb823a31f077204b318f05ca688554a",
"sha256": "e0f52cce27debdc8136414e879ed1460fc610cb0c24bfe637ab9a9ae54afb2ca"
},
"downloads": -1,
"filename": "xify-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "beb823a31f077204b318f05ca688554a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7628,
"upload_time": "2025-10-06T22:18:38",
"upload_time_iso_8601": "2025-10-06T22:18:38.551137Z",
"url": "https://files.pythonhosted.org/packages/02/ba/07e561fbafbc7a6ab017f05b593008a466518256918ebb436a0c6c726cae/xify-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-06 22:18:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "filming",
"github_project": "xify",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "xify"
}
