financial identifier validation.
Project description
# cymbology
cymbology identifies and validates financial security ids. Currently the following identifiers are supported:
1. Sedol
2. Cusip
3. Isin
This package can be used to validate these identifiers, discover the validation error, or create checksum digits.
# Example Usage:
### ISIN number
```python
from cymbology import Isin, cusip_from_isin
isin = Isin()
# validate ISIN number 'US0378331005', throwing error IdError if invalid
>>> valid_isin = isin.validate('US0378331005')
>>> valid_isin
'US0378331005'
# return validation boolean for ISIN number
>>> tf = isin.is_valid('US0378331005')
>>> tf
True
# calculate checksum for ISIN number 'US0378331005'
check_digit = isin.calculate_checksum('US037833100')
# convert ISIN to CUSIP number.
>>> cusip_from_isin('US0378331005')
'037833100'
```
# Dependancies and Installation Notes
This package currently only relies on the standard library, and has not been tested for Python 2.X.
# Running Tests
PYTHONPATH=. py.test --cov
# Extending
Idenifiers that rely on alpha-numeric codes should be able to be easily extended. Feel free to add additional identification algorithmns. Legal Indenifiers(LEI) ids will be added to master branch of repo soon.
cymbology identifies and validates financial security ids. Currently the following identifiers are supported:
1. Sedol
2. Cusip
3. Isin
This package can be used to validate these identifiers, discover the validation error, or create checksum digits.
# Example Usage:
### ISIN number
```python
from cymbology import Isin, cusip_from_isin
isin = Isin()
# validate ISIN number 'US0378331005', throwing error IdError if invalid
>>> valid_isin = isin.validate('US0378331005')
>>> valid_isin
'US0378331005'
# return validation boolean for ISIN number
>>> tf = isin.is_valid('US0378331005')
>>> tf
True
# calculate checksum for ISIN number 'US0378331005'
check_digit = isin.calculate_checksum('US037833100')
# convert ISIN to CUSIP number.
>>> cusip_from_isin('US0378331005')
'037833100'
```
# Dependancies and Installation Notes
This package currently only relies on the standard library, and has not been tested for Python 2.X.
# Running Tests
PYTHONPATH=. py.test --cov
# Extending
Idenifiers that rely on alpha-numeric codes should be able to be easily extended. Feel free to add additional identification algorithmns. Legal Indenifiers(LEI) ids will be added to master branch of repo soon.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cymbology-0.2.3.tar.gz
(6.0 kB
view details)
Built Distribution
File details
Details for the file cymbology-0.2.3.tar.gz
.
File metadata
- Download URL: cymbology-0.2.3.tar.gz
- Upload date:
- Size: 6.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c087077fcbc705e3ea34d5084ae3f44b84f86c68f4d0812bf74cd02b8d9cd6e |
|
MD5 | 82351a6411260da9dc2fec0acf0c6196 |
|
BLAKE2b-256 | 2f912ad05dbbe31eff6b491a3349b068620abaf5ca76790c105f43b1110ba129 |
File details
Details for the file cymbology-0.2.3-py3-none-any.whl
.
File metadata
- Download URL: cymbology-0.2.3-py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0681bdeaca06954001bf0137723807eeede7dea9f63163e76f568c272f81b7d |
|
MD5 | 94a816bc2e90f3ad09d18052ee4a7138 |
|
BLAKE2b-256 | debf448d0d412c39676cce3de85721073b02ffffd6fe61140e01bebbc9866120 |