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.8",
"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/d0/c2/f4207515c9748fc85bada811e4d3e55739f6f54fd5d77cb75edbf18c0baf/iso10383-2024.9.9.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": "2024.9.9",
"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": "3264c61c2b4121a42f50dd8ce801a2b0d29e602fc0bd60aa79e2328a188f15e9",
"md5": "9bf7fc644518b3aff659a1886135835b",
"sha256": "330c0b1ccb64cd8a6868ff64f7cf9aa676e0811b20149d83b70398c55fa5ebdd"
},
"downloads": -1,
"filename": "iso10383-2024.9.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9bf7fc644518b3aff659a1886135835b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23745,
"upload_time": "2024-10-03T21:35:37",
"upload_time_iso_8601": "2024-10-03T21:35:37.354309Z",
"url": "https://files.pythonhosted.org/packages/32/64/c61c2b4121a42f50dd8ce801a2b0d29e602fc0bd60aa79e2328a188f15e9/iso10383-2024.9.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d0c2f4207515c9748fc85bada811e4d3e55739f6f54fd5d77cb75edbf18c0baf",
"md5": "40cd5ee41d2a9088e36b3e9b84064ea7",
"sha256": "67cc5e1e6539dbbe00a527375cc85dfab96fea2a102bd0da8e7ab6647981c872"
},
"downloads": -1,
"filename": "iso10383-2024.9.9.tar.gz",
"has_sig": false,
"md5_digest": "40cd5ee41d2a9088e36b3e9b84064ea7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 25028,
"upload_time": "2024-10-03T21:35:39",
"upload_time_iso_8601": "2024-10-03T21:35:39.300118Z",
"url": "https://files.pythonhosted.org/packages/d0/c2/f4207515c9748fc85bada811e4d3e55739f6f54fd5d77cb75edbf18c0baf/iso10383-2024.9.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-03 21:35:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tanrbobanr",
"github_project": "iso10383",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "iso10383"
}
JSON
