Skip to main content

Python package using the API of CrossoutDB

Project description

Crossout Python package

The crossout Python package is a Python library for interacting with the Crossout API provided by the CrossoutDB website. It is designed to be simple to use and gives general information about the game items. As it is based on a third party API, data may be outdated or missing.

Note : At the moment, the package does not provide information about the market state and item prices.

Note : This package is not affiliated with CrossoutDB, Targem Games or Gaijin Enternaiment in any way.

How to use

Requirements

The package was made with Python 3.10.4. Although its dependencies should be automatically installed by pip, here is a list of the required packages :

Installation

The package is available on PyPI and can be installed using pip:

pip install crossout

Usage

The package provides a core class called CrossoutDB. It wraps the lower level API calls and provides a simple interface to get information about the game items. Here the sample code retrieve the name of the item with the ID 1050, which is the ZS-33 Hulk.

import crossout

# Create a CrossoutDB instance
db = crossout.CrossoutDB()
name = db.item(1050).name
# name = "ZS-33 Hulk"

Roadmap

In order of priority :

  • Make documentation
  • Consider adding option to scrap additionnal data from the website if possible
  • Add support for item prices
  • Add support for market data

Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crossout-1.0.0.tar.gz (19.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

crossout-1.0.0-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

Details for the file crossout-1.0.0.tar.gz.

File metadata

  • Download URL: crossout-1.0.0.tar.gz
  • Upload date:
  • Size: 19.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.4

File hashes

Hashes for crossout-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e80ff5d5ea21c253d7e4045c546cd7d98ca377443755b68feaeef33ced232555
MD5 108d1f291454cee67c170725a1b2fc07
BLAKE2b-256 d6935d393135c2e3cfc5da65cf6c4f9731f38a1268c3441c09e57d1975296ca9

See more details on using hashes here.

File details

Details for the file crossout-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: crossout-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 19.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.4

File hashes

Hashes for crossout-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9bfb2c396005213da21b58370478f00e8391b5638f559b6ef69da7cc164c2534
MD5 deb6a127ae69cbbc3a73c504d7675efb
BLAKE2b-256 c3da197facb29c08549a19a8099c0dcfecbcb5c31825c57e8f8776f7912c9302

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page