iso10383


Nameiso10383 JSON
Version 2025.2.10 PyPI version JSON
download
home_pageNone
SummaryA Python wrapper around the data provided by the ISO 10383 specification.
upload_time2025-02-15 18:10:03
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseApache 2.0
keywords iso10383 iso 10383 iso-10383 iso market identifier codes mics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            A Python wrapper around the data provided by the ISO 10383 specification.

# Install
`$ pip install iso10383`

# Usage
The package is relatively easy to use. The `MIC` class is the enum that
contains all the entries:
```py
>>> from iso10383 import MIC
>>> MIC.xnys.value
MICEntry(
    mic='XNYS',
    market_name='NEW YORK STOCK EXCHANGE, INC.',
    market_category_code=<MCC.nspd: 6>,
    creation_date=datetime.date(2005, 5, 23),
    status=<Status.active: 0>,
    city=<City.new_york: 208>,
    operating_mic=None,
    institution_description=None,
    legel_entity_name=None,
    legal_entity_identifier=None,
    acronym='NYSE',
    iso_country_code=<ISOCC.us: 137>,
    website='www.nyse.com',
    last_update_date=datetime.date(2005, 5, 23),
    last_validation_date=None,
    expiry_date=None,
    comments=None
)

```
Each `MICEntry` has the following attributes, which correspond to those found
in [the specification](https://www.iso20022.org/market-identifier-codes):
```py
mic                     : str
market_name             : str
market_category_code    : MCC
creation_date           : datetime.date
status                  : Status
city                    : City          | None
operating_mic           : MICEntry      | None
institution_description : str           | None
legel_entity_name       : str           | None
legal_entity_identifier : str           | None
acronym                 : str           | None
iso_country_code        : ISOCC         | None
website                 : str           | None
last_update_date        : datetime.date | None
last_validation_date    : datetime.date | None
expiry_date             : datetime.date | None
comments                : str           | None
```
`MCC`, `Status`, `City`, and `ISOCC` are supporting enums that can be imported
separately.

The operating/segment column is notably not present, and is instead indicated
by the presence of the `operating_mic` attribute (that is, whether or not it is
`None`).

# Notes
Given the large number of entries in the ISO 10383 specification, hard-coding
an enum would cause major performance issues with intellisense and linters. For
this reason, a dummy enum was hardcoded, and is then replaced by deserializing
the contents at runtime. This means there is a small performance hit (on the
order of milliseconds) at runtime when the module is imported.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "iso10383",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "Tanner Corcoran <tannerbcorcoran@gmail.com>",
    "keywords": "iso10383, iso 10383, iso-10383, iso, market identifier codes, mics",
    "author": null,
    "author_email": "Tanner Corcoran <tannerbcorcoran@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/6c/00/a9567132cbf41df75f893bc6eb717a3fc6698f8e0ea0082feb6a0d220436/iso10383-2025.2.10.tar.gz",
    "platform": null,
    "description": "A Python wrapper around the data provided by the ISO 10383 specification.\n\n# Install\n`$ pip install iso10383`\n\n# Usage\nThe package is relatively easy to use. The `MIC` class is the enum that\ncontains all the entries:\n```py\n>>> from iso10383 import MIC\n>>> MIC.xnys.value\nMICEntry(\n    mic='XNYS',\n    market_name='NEW YORK STOCK EXCHANGE, INC.',\n    market_category_code=<MCC.nspd: 6>,\n    creation_date=datetime.date(2005, 5, 23),\n    status=<Status.active: 0>,\n    city=<City.new_york: 208>,\n    operating_mic=None,\n    institution_description=None,\n    legel_entity_name=None,\n    legal_entity_identifier=None,\n    acronym='NYSE',\n    iso_country_code=<ISOCC.us: 137>,\n    website='www.nyse.com',\n    last_update_date=datetime.date(2005, 5, 23),\n    last_validation_date=None,\n    expiry_date=None,\n    comments=None\n)\n\n```\nEach `MICEntry` has the following attributes, which correspond to those found\nin [the specification](https://www.iso20022.org/market-identifier-codes):\n```py\nmic                     : str\nmarket_name             : str\nmarket_category_code    : MCC\ncreation_date           : datetime.date\nstatus                  : Status\ncity                    : City          | None\noperating_mic           : MICEntry      | None\ninstitution_description : str           | None\nlegel_entity_name       : str           | None\nlegal_entity_identifier : str           | None\nacronym                 : str           | None\niso_country_code        : ISOCC         | None\nwebsite                 : str           | None\nlast_update_date        : datetime.date | None\nlast_validation_date    : datetime.date | None\nexpiry_date             : datetime.date | None\ncomments                : str           | None\n```\n`MCC`, `Status`, `City`, and `ISOCC` are supporting enums that can be imported\nseparately.\n\nThe operating/segment column is notably not present, and is instead indicated\nby the presence of the `operating_mic` attribute (that is, whether or not it is\n`None`).\n\n# Notes\nGiven the large number of entries in the ISO 10383 specification, hard-coding\nan enum would cause major performance issues with intellisense and linters. For\nthis reason, a dummy enum was hardcoded, and is then replaced by deserializing\nthe contents at runtime. This means there is a small performance hit (on the\norder of milliseconds) at runtime when the module is imported.\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "A Python wrapper around the data provided by the ISO 10383 specification.",
    "version": "2025.2.10",
    "project_urls": {
        "Bug Tracker": "https://github.com/tanrbobanr/iso10383/issues",
        "Changelog": "https://github.com/tanrbobanr/iso10383/blob/main/CHANGELOG.md",
        "Documentation": "https://github.com/tanrbobanr/iso10383/blob/main/README.md",
        "Homepage": "https://github.com/tanrbobanr/iso10383",
        "License": "https://github.com/tanrbobanr/iso10383/blob/main/LICENSE",
        "Source": "https://github.com/tanrbobanr/iso10383"
    },
    "split_keywords": [
        "iso10383",
        " iso 10383",
        " iso-10383",
        " iso",
        " market identifier codes",
        " mics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fa64e6a75e44db0bb8835bfff84e6aa302627c440bf7cf689c2c27f944e013d6",
                "md5": "400e5d083b09b90768f704f59051d537",
                "sha256": "0f3465e10f35481e28ad24dcb29491a5995335337622f86ed12bc1ac65e99cb4"
            },
            "downloads": -1,
            "filename": "iso10383-2025.2.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "400e5d083b09b90768f704f59051d537",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 153246,
            "upload_time": "2025-02-15T18:10:01",
            "upload_time_iso_8601": "2025-02-15T18:10:01.526118Z",
            "url": "https://files.pythonhosted.org/packages/fa/64/e6a75e44db0bb8835bfff84e6aa302627c440bf7cf689c2c27f944e013d6/iso10383-2025.2.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6c00a9567132cbf41df75f893bc6eb717a3fc6698f8e0ea0082feb6a0d220436",
                "md5": "707508a0c7fae1c13297e4ab91aebe6c",
                "sha256": "ba87ca7d7a73faa3b03b30019af620a10afc298c63645d35e256dd425c963179"
            },
            "downloads": -1,
            "filename": "iso10383-2025.2.10.tar.gz",
            "has_sig": false,
            "md5_digest": "707508a0c7fae1c13297e4ab91aebe6c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 154464,
            "upload_time": "2025-02-15T18:10:03",
            "upload_time_iso_8601": "2025-02-15T18:10:03.008771Z",
            "url": "https://files.pythonhosted.org/packages/6c/00/a9567132cbf41df75f893bc6eb717a3fc6698f8e0ea0082feb6a0d220436/iso10383-2025.2.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-15 18:10:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tanrbobanr",
    "github_project": "iso10383",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "iso10383"
}
        
Elapsed time: 0.40995s