pmart123 / cymbology

Identifies and validates financial security ids such as Sedol, Cusip, Isin numbers.

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

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's Issues

security-validation branch

Error in running feature tests, not recognizing name

Branch:
https://github.com/pmart123/security_id/tree/security-validation

(root)Philips-MacBook-Pro-2:features pmartin$ behave
Exception KeyError: "'__name__' not in globals"
Traceback (most recent call last):
  File "/Users/pmartin/anaconda/bin/behave", line 11, in <module>
    sys.exit(main())
  File "/Users/pmartin/anaconda/lib/python3.4/site-packages/behave/__main__.py", line 109, in main
    failed = runner.run()
  File "/Users/pmartin/anaconda/lib/python3.4/site-packages/behave/runner.py", line 672, in run
    return self.run_with_paths()
  File "/Users/pmartin/anaconda/lib/python3.4/site-packages/behave/runner.py", line 678, in run_with_paths
    self.load_step_definitions()
  File "/Users/pmartin/anaconda/lib/python3.4/site-packages/behave/runner.py", line 658, in load_step_definitions
    exec_file(os.path.join(path, name), step_module_globals)
  File "/Users/pmartin/anaconda/lib/python3.4/site-packages/behave/runner.py", line 304, in exec_file
    exec(code, globals, locals)
  File "steps/steps.py", line 4, in <module>
    from ... import security_id
KeyError: "'__name__' not in globals"

CountryCodeError Outdated: CUSIP is applicable to ISIN that starts with more than US

CUSIP is not applicable only to US