Metadata-Version: 2.4
Name: fdev-ids
Version: 1.0.0
Summary: Data from https://github.com/EDCD/FDevIDs bundled in Python data structures.
Author: Julien de la Bruère-Terreault
Maintainer: Julien de la Bruère-Terreault
License-Expression: MIT
Project-URL: Homepage, https://codeberg.org/jdlbt/fdev-ids-python
Project-URL: Issue tracker, https://codeberg.org/jdlbt/fdev-ids-python/issues
Project-URL: Source, https://codeberg.org/jdlbt/fdev-ids-python
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-regressions; extra == "tests"
Provides-Extra: dev
Requires-Dist: fdev-ids[tests]; extra == "dev"
Requires-Dist: black==25.9.0; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: flake8==7.3.0; extra == "dev"
Requires-Dist: isort==6.1.0; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: tox; extra == "dev"
Dynamic: license-file

# fdev-ids-python

Data from https://github.com/EDCD/FDevIDs bundled in Python data structures.

## Installation

    pip install fdev-ids

## Usage

Load a table by specifying the lowercase table name:

```pycon
>>> from pprint import pprint
>>> from fdev_ids import load_table
>>> bundles = load_table("bundles")
>>> pprint(bundles)
{129030471: {'id': 129030471,
             'name': 'AX COMBAT JUMPSTART ALLIANCE CHIEFTAIN',
             'sku': 'FORC_FDEV_V_CHIEFTAIN_BUNDLE_001'},
 129030472: {'id': 129030472,
             'name': 'LASER MINING JUMPSTART TYPE-6',
             'sku': 'FORC_FDEV_V_TYPE6_BUNDLE_001'},
 129030473: {'id': 129030473,
             'name': 'EXPLORATION JUMPSTART DIAMONDBACK EXPLORER',
             'sku': 'FORC_FDEV_V_DIAMOND_EXPLORER_BUNDLE_001'},
 129030512: {'id': 129030512,
             'name': 'PYTHON MK II STELLAR',
             'sku': 'FORC_FDEV_V_PYTHON_MKII_BUNDLE_001'},
 129030519: {'id': 129030519,
             'name': 'PYTHON MK II STANDARD',
             'sku': 'FORC_FDEV_V_PYTHON_MKII_BUNDLE_002'}}
```

Tables with a single value per ID return the value directly for each ID:

```pycon
>>> factionids = load_table("factionids")
>>> pprint(factionids)
{'$faction_Alliance;': 'Alliance',
 '$faction_Empire;': 'Empire',
 '$faction_Federation;': 'Federation',
 '$faction_FrontlineSolutions;': 'Frontline Solutions',
 '$faction_Independent;': 'Independent',
 '$faction_Pirate;': 'Pirate',
 '$faction_Thargoid;': 'Thargoid',
 '$faction_none;': 'None'}
```

Similarily when only the ID is defined:

```pycon
>>> dockingdeniedreasons = load_table("dockingdeniedreasons")
>>> pprint(dockingdeniedreasons)
{'ActiveFighter': 'ActiveFighter',
 'Distance': 'Distance',
 'Hostile': 'Hostile',
 'NoSpace': 'NoSpace',
 'Offences': 'Offences',
 'RestrictedAccess': 'RestrictedAccess',
 'TooLarge': 'TooLarge'}
```

## Terms of Use

The data contained in this package is based on publicly available information sourced from https://github.com/EDCD/FDevIDs and subject to the [Elite Dangerous EULA and Terms of Use](https://www.frontierstore.net/ed-eula/).

The MIT license applies to the code in this repository only.

## Issues & support

Report issues with the package itself at https://codeberg.org/jdlbt/fdev-ids-python/issues.

For issues with or updates to the data tables, refer to https://github.com/EDCD/FDevIDs/issues.


## Development

See [CONTRIBUTING](CONTRIBUTING.md).
