| Name | pyscx JSON |
| Version |
1.1.3
JSON |
| download |
| home_page | None |
| Summary | A library for interacting with the STALCRAFT: X API |
| upload_time | 2025-02-18 10:43:45 |
| maintainer | None |
| docs_url | None |
| author | Oidaho |
| requires_python | >=3.13 |
| license | LICENSE |
| keywords |
api
library
eapi
stalcraft
package
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ☢️ PYSCX
This library is designed to simplify your interaction with the **STALCRAFT: X API**, providing a robust and developer-friendly interface for accessing game data.
Whether you're building tools, analyzing game statistics, or creating custom applications, this library offers an intuitive way to retrieve and work with **STALCRAFT: X** data.
> [!NOTE]
> STALCRAFT: X API - v1.0.0
>
> Python 3.13+
---
## ✨ Features
- **Easy-to-use interface**
Designed with simplicity in mind, so you can focus on building awesome stuff!
- **Full coverage of endpoints**
Access all available API endpoints without hassle.
- **Automatic data wrapping**
Get your data in a clean, ready-to-use format.
- **Flexible token setup**
Easily configure and manage your API tokens.
## 📦 Installation
To install the library, run the following command:
```bash
pip install pyscx
```
Or, if you want to install the library directly from GitHub:
```bash
pip install git+https://github.com/Oidaho/pyscx.git
```
## 🛠️ Quick Start
Here’s a quick example to get you started:
```python
import os
from dotenv import load_dotenv
from pyscx import Server, API
from pyscx.token import Token, TokenType
load_dotenv()
app_token = Token(
value=os.getenv("DEMO_APP_ACCESS_TOKEN"),
type=TokenType.APPLICATION,
)
user_token = Token(
value=os.getenv("DEMO_USER_ACCESS_TOKEN"),
type=TokenType.USER,
)
api = API(server=Server.DEMO, tokens=[user_token, app_token])
print(api.clans(region="EU").get_all())
```
## 📚 Documentation
For detailed documentation, check out the official [docs](https://Oidaho.github.io/pyscx/)
## 🚀 Project Ideas
Here are some cool project ideas to inspire you:
- **Auction Analyzer**: Build a tool to track item prices and find profitable deals.
- **Emission Tracker**: Create a notification system for emission start and end times.
- **Player Statistics Dashboard**: Develop a dashboard to analyze player and clan stats.
- **Social Tracker**: Monitor friends programmatically.
## 🤝 Contributing
We welcome contributions! If you have ideas, suggestions, or found a bug, please open an [issue](https://github.com/Oidaho/pyscx/issues) or submit a pull request.
## 📜 License
This project is licensed under the [GPL-3.0 License](https://github.com/Oidaho/pyscx/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "pyscx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.13",
"maintainer_email": null,
"keywords": "api, library, eapi, stalcraft, package",
"author": "Oidaho",
"author_email": "oidaho.main@yandex.ru",
"download_url": "https://files.pythonhosted.org/packages/dc/f7/292af8b8685d915a9fde8e3bbff3c22ec0ec86ceb35823c733f6e261723f/pyscx-1.1.3.tar.gz",
"platform": null,
"description": "# \u2622\ufe0f PYSCX\n\n\n\n\n\n\n\n\n\nThis library is designed to simplify your interaction with the **STALCRAFT: X API**, providing a robust and developer-friendly interface for accessing game data.\n\nWhether you're building tools, analyzing game statistics, or creating custom applications, this library offers an intuitive way to retrieve and work with **STALCRAFT: X** data.\n\n> [!NOTE]\n> STALCRAFT: X API - v1.0.0\n>\n> Python 3.13+\n\n---\n\n## \u2728 Features\n\n- **Easy-to-use interface** \n Designed with simplicity in mind, so you can focus on building awesome stuff! \n- **Full coverage of endpoints**\n Access all available API endpoints without hassle. \n- **Automatic data wrapping** \n Get your data in a clean, ready-to-use format. \n- **Flexible token setup** \n Easily configure and manage your API tokens. \n\n## \ud83d\udce6 Installation\n\nTo install the library, run the following command:\n\n```bash\npip install pyscx\n```\n\nOr, if you want to install the library directly from GitHub:\n\n```bash\npip install git+https://github.com/Oidaho/pyscx.git\n```\n\n## \ud83d\udee0\ufe0f Quick Start\n\nHere\u2019s a quick example to get you started:\n\n```python\nimport os\nfrom dotenv import load_dotenv\n\nfrom pyscx import Server, API\nfrom pyscx.token import Token, TokenType\n\n\nload_dotenv()\n\napp_token = Token(\n value=os.getenv(\"DEMO_APP_ACCESS_TOKEN\"),\n type=TokenType.APPLICATION,\n)\nuser_token = Token(\n value=os.getenv(\"DEMO_USER_ACCESS_TOKEN\"),\n type=TokenType.USER,\n)\n\n\napi = API(server=Server.DEMO, tokens=[user_token, app_token])\n\nprint(api.clans(region=\"EU\").get_all())\n```\n\n## \ud83d\udcda Documentation\n\nFor detailed documentation, check out the official [docs](https://Oidaho.github.io/pyscx/)\n\n## \ud83d\ude80 Project Ideas\n\nHere are some cool project ideas to inspire you:\n\n- **Auction Analyzer**: Build a tool to track item prices and find profitable deals.\n- **Emission Tracker**: Create a notification system for emission start and end times.\n- **Player Statistics Dashboard**: Develop a dashboard to analyze player and clan stats.\n- **Social Tracker**: Monitor friends programmatically.\n\n## \ud83e\udd1d Contributing\n\nWe welcome contributions! If you have ideas, suggestions, or found a bug, please open an [issue](https://github.com/Oidaho/pyscx/issues) or submit a pull request.\n\n## \ud83d\udcdc License\n\nThis project is licensed under the [GPL-3.0 License](https://github.com/Oidaho/pyscx/blob/main/LICENSE).\n\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "A library for interacting with the STALCRAFT: X API",
"version": "1.1.3",
"project_urls": {
"Bug Tracker": "https://github.com/Oidaho/pyscx/issues",
"Documentation": "https://Oidaho.github.io/pyscx/",
"Repository": "https://github.com/Oidaho/pyscx"
},
"split_keywords": [
"api",
" library",
" eapi",
" stalcraft",
" package"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3da556da50e86f6bd51c377fc76c5776d3784d26619ed8daf5bbed8ece2db4be",
"md5": "300d3c10509e8a3d6d9d533990b87e7f",
"sha256": "457f2dc7ec835b674aa34fbdb1000a1b409eb8ef323f48f8968356c067a3bc3c"
},
"downloads": -1,
"filename": "pyscx-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "300d3c10509e8a3d6d9d533990b87e7f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.13",
"size": 23574,
"upload_time": "2025-02-18T10:43:43",
"upload_time_iso_8601": "2025-02-18T10:43:43.402245Z",
"url": "https://files.pythonhosted.org/packages/3d/a5/56da50e86f6bd51c377fc76c5776d3784d26619ed8daf5bbed8ece2db4be/pyscx-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dcf7292af8b8685d915a9fde8e3bbff3c22ec0ec86ceb35823c733f6e261723f",
"md5": "12481fd42d75b16dd5d799a535cb0dc6",
"sha256": "4f873f824e481b2ad8828a52a2340ee4aa036cc265de57b79c4e549584404c94"
},
"downloads": -1,
"filename": "pyscx-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "12481fd42d75b16dd5d799a535cb0dc6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.13",
"size": 22286,
"upload_time": "2025-02-18T10:43:45",
"upload_time_iso_8601": "2025-02-18T10:43:45.834437Z",
"url": "https://files.pythonhosted.org/packages/dc/f7/292af8b8685d915a9fde8e3bbff3c22ec0ec86ceb35823c733f6e261723f/pyscx-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-18 10:43:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Oidaho",
"github_project": "pyscx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyscx"
}
