pyocf.captable

OCF Captable object

class pyocf.captable.Captable

classmethod load(location)

Imports OCF data

location needs to be a string or a pathlib.Path() pointing at a zipfile or directory containing the OCF files, or it must be a file-like object containing a zip-file.

manifest: OCFManifestFile = None

save(location, manifest_path='Manifest.ocf.json', issuer=None, zip=True, pretty=True)

Save the captable to a zipfile or a directory

For each file type, only one file will be created. If several file names are specified only the first one will be used.

save_directory(outdirectory, manifest_path='Manifest.ocf.json', issuer=None, pretty=True)

Save to a directory

save_zipfile(outzipfile, manifest_path='Manifest.ocf.json', issuer=None, pretty=True)

Save to an already open zipfile

Useful if you require non-standard compression or other zipfile options, then you can open the zipfile yourself and use this function to save to it.

stakeholders: list[Stakeholder] = []

stock_classes: list[StockClass] = []

stock_legend_templates: list[StockLegendTemplate] = []

stock_plans: list[StockPlan] = []

transactions: list[Transaction] = []

valuations: list[Valuation] = []

vesting_terms: list[VestingTerms] = []