8.1. stelar namespace

8.1.1. Subpackages

• 8.1.1.1. stelar.client package
  • Subpackages
    • stelar.client.proxy package
      • Submodules
      • stelar.client.proxy.decl module
      • stelar.client.proxy.derived module
      • stelar.client.proxy.exceptions module
      • stelar.client.proxy.extras module
      • stelar.client.proxy.fieldvalidation module
      • stelar.client.proxy.property module
      • stelar.client.proxy.proxy module
      • stelar.client.proxy.proxycursor module
      • stelar.client.proxy.proxylist module
      • stelar.client.proxy.proxysync module
      • stelar.client.proxy.refs module
      • stelar.client.proxy.registry module
      • stelar.client.proxy.schema module
      • stelar.client.proxy.tag module
      • stelar.client.proxy.typing module
      • Module contents
  • Submodules
  • stelar.client.admin module
    • AdminAPI
  • stelar.client.api_call module
    • api_call
      • api_call.dataset_export_zenodo()
      • api_call.entity_search()
      • api_call.image_registry_token_create()
      • api_call.image_registry_token_delete()
      • api_call.image_registry_token_list()
      • api_call.image_registry_token_show()
      • api_call.policy_create()
      • api_call.policy_fetch()
      • api_call.policy_list()
      • api_call.policy_show()
      • api_call.policy_spec()
      • api_call.relationship_create()
      • api_call.relationship_delete()
      • api_call.relationship_show()
      • api_call.relationship_update()
      • api_call.relationships_fetch()
      • api_call.resource_lineage()
      • api_call.roles_fetch()
      • api_call.task_job_input()
      • api_call.task_list()
      • api_call.task_post_job_output()
      • api_call.task_show_jobs()
      • api_call.task_show_logs()
      • api_call.task_signature()
      • api_call.user_add_role()
      • api_call.user_add_roles()
      • api_call.user_create()
      • api_call.user_delete()
      • api_call.user_fetch()
      • api_call.user_list()
      • api_call.user_patch()
      • api_call.user_purge()
      • api_call.user_remove_role()
      • api_call.user_set_roles()
      • api_call.user_show()
      • api_call.user_update()
    • api_call_base
      • api_call_base.dataset_create()
      • api_call_base.dataset_delete()
      • api_call_base.dataset_fetch()
      • api_call_base.dataset_list()
      • api_call_base.dataset_patch()
      • api_call_base.dataset_purge()
      • api_call_base.dataset_search()
      • api_call_base.dataset_show()
      • api_call_base.dataset_update()
      • api_call_base.get_call()
      • api_call_base.group_add_dataset()
      • api_call_base.group_add_group()
      • api_call_base.group_add_tool()
      • api_call_base.group_add_user()
      • api_call_base.group_add_workflow()
      • api_call_base.group_create()
      • api_call_base.group_delete()
      • api_call_base.group_fetch()
      • api_call_base.group_list()
      • api_call_base.group_list_members_dataset()
      • api_call_base.group_list_members_group()
      • api_call_base.group_list_members_tool()
      • api_call_base.group_list_members_user()
      • api_call_base.group_list_members_workflow()
      • api_call_base.group_patch()
      • api_call_base.group_purge()
      • api_call_base.group_remove_dataset()
      • api_call_base.group_remove_group()
      • api_call_base.group_remove_tool()
      • api_call_base.group_remove_user()
      • api_call_base.group_remove_workflow()
      • api_call_base.group_search()
      • api_call_base.group_show()
      • api_call_base.group_update()
      • api_call_base.image_registry_token_create()
      • api_call_base.image_registry_token_delete()
      • api_call_base.image_registry_token_fetch()
      • api_call_base.image_registry_token_list()
      • api_call_base.image_registry_token_patch()
      • api_call_base.image_registry_token_purge()
      • api_call_base.image_registry_token_search()
      • api_call_base.image_registry_token_show()
      • api_call_base.image_registry_token_update()
      • api_call_base.license_create()
      • api_call_base.license_delete()
      • api_call_base.license_fetch()
      • api_call_base.license_list()
      • api_call_base.license_patch()
      • api_call_base.license_purge()
      • api_call_base.license_search()
      • api_call_base.license_show()
      • api_call_base.license_update()
      • api_call_base.organization_add_dataset()
      • api_call_base.organization_add_group()
      • api_call_base.organization_add_tool()
      • api_call_base.organization_add_user()
      • api_call_base.organization_add_workflow()
      • api_call_base.organization_create()
      • api_call_base.organization_delete()
      • api_call_base.organization_fetch()
      • api_call_base.organization_list()
      • api_call_base.organization_list_members_dataset()
      • api_call_base.organization_list_members_group()
      • api_call_base.organization_list_members_tool()
      • api_call_base.organization_list_members_user()
      • api_call_base.organization_list_members_workflow()
      • api_call_base.organization_patch()
      • api_call_base.organization_purge()
      • api_call_base.organization_remove_dataset()
      • api_call_base.organization_remove_group()
      • api_call_base.organization_remove_tool()
      • api_call_base.organization_remove_user()
      • api_call_base.organization_remove_workflow()
      • api_call_base.organization_search()
      • api_call_base.organization_show()
      • api_call_base.organization_update()
      • api_call_base.policy_create()
      • api_call_base.policy_delete()
      • api_call_base.policy_fetch()
      • api_call_base.policy_list()
      • api_call_base.policy_patch()
      • api_call_base.policy_purge()
      • api_call_base.policy_search()
      • api_call_base.policy_show()
      • api_call_base.policy_update()
      • api_call_base.process_add_task()
      • api_call_base.process_create()
      • api_call_base.process_delete()
      • api_call_base.process_fetch()
      • api_call_base.process_list()
      • api_call_base.process_list_members_task()
      • api_call_base.process_patch()
      • api_call_base.process_purge()
      • api_call_base.process_remove_task()
      • api_call_base.process_search()
      • api_call_base.process_show()
      • api_call_base.process_update()
      • api_call_base.request()
      • api_call_base.resource_create()
      • api_call_base.resource_delete()
      • api_call_base.resource_fetch()
      • api_call_base.resource_list()
      • api_call_base.resource_patch()
      • api_call_base.resource_purge()
      • api_call_base.resource_search()
      • api_call_base.resource_show()
      • api_call_base.resource_update()
      • api_call_base.tag_create()
      • api_call_base.tag_delete()
      • api_call_base.tag_fetch()
      • api_call_base.tag_list()
      • api_call_base.tag_patch()
      • api_call_base.tag_purge()
      • api_call_base.tag_search()
      • api_call_base.tag_show()
      • api_call_base.tag_update()
      • api_call_base.task_create()
      • api_call_base.task_delete()
      • api_call_base.task_fetch()
      • api_call_base.task_list()
      • api_call_base.task_patch()
      • api_call_base.task_purge()
      • api_call_base.task_search()
      • api_call_base.task_show()
      • api_call_base.task_update()
      • api_call_base.tool_create()
      • api_call_base.tool_delete()
      • api_call_base.tool_fetch()
      • api_call_base.tool_list()
      • api_call_base.tool_patch()
      • api_call_base.tool_purge()
      • api_call_base.tool_search()
      • api_call_base.tool_show()
      • api_call_base.tool_update()
      • api_call_base.user_create()
      • api_call_base.user_delete()
      • api_call_base.user_fetch()
      • api_call_base.user_list()
      • api_call_base.user_patch()
      • api_call_base.user_purge()
      • api_call_base.user_search()
      • api_call_base.user_show()
      • api_call_base.user_update()
      • api_call_base.vocabulary_create()
      • api_call_base.vocabulary_delete()
      • api_call_base.vocabulary_fetch()
      • api_call_base.vocabulary_list()
      • api_call_base.vocabulary_patch()
      • api_call_base.vocabulary_purge()
      • api_call_base.vocabulary_search()
      • api_call_base.vocabulary_show()
      • api_call_base.vocabulary_update()
      • api_call_base.workflow_create()
      • api_call_base.workflow_delete()
      • api_call_base.workflow_fetch()
      • api_call_base.workflow_list()
      • api_call_base.workflow_patch()
      • api_call_base.workflow_purge()
      • api_call_base.workflow_search()
      • api_call_base.workflow_show()
      • api_call_base.workflow_update()
    • api_context
    • api_model
      • api_model.from_value()
      • api_model.get_method()
    • gcall()
    • generate_add()
    • generate_create()
    • generate_delete()
    • generate_fetch()
    • generate_list()
    • generate_list_members()
    • generate_patch()
    • generate_purge()
    • generate_remove()
    • generate_resource_search()
    • generate_show()
    • generate_solr_search()
    • generate_unimplemented()
    • generate_update()
  • stelar.client.backdoor module
    • CKAN
      • CKAN.check()
    • api_call_DC
      • api_call_DC.get_call()
  • stelar.client.base module
    • BaseAPI
      • BaseAPI.DELETE()
      • BaseAPI.GET()
      • BaseAPI.PATCH()
      • BaseAPI.POST()
      • BaseAPI.PUT()
      • BaseAPI.api
      • BaseAPI.api_request()
      • BaseAPI.api_url
      • BaseAPI.cursor_for()
      • BaseAPI.klms_info
      • BaseAPI.listapi()
      • BaseAPI.request()
      • BaseAPI.reset_tokens()
      • BaseAPI.token
      • BaseAPI.token_expired()
    • KLMSInfo
  • stelar.client.catalog module
    • CatalogAPI
      • CatalogAPI.fetch_active_vocabularies()
  • stelar.client.client module
    • Client
      • Client.DC
      • Client.authenticate()
      • Client.reauthenticate()
      • Client.token_refresh()
  • stelar.client.dataset module
    • Dataset
      • Dataset.add_dataframe()
      • Dataset.export_zenodo()
      • Dataset.proxy_schema
      • Dataset.read_dataframe()
      • Dataset.spatial
      • Dataset.title
      • Dataset.url
      • Dataset.version
    • DatasetCursor
      • DatasetCursor.publish_dataframe()
      • DatasetCursor.publish_file()
  • stelar.client.generic module
    • GenericCursor
      • GenericCursor.create()
      • GenericCursor.fetch()
      • GenericCursor.fetch_list()
      • GenericCursor.get()
    • GenericProxy
      • GenericProxy.delete()
      • GenericProxy.id
      • GenericProxy.proxy_sync()
    • GenericProxyList
      • GenericProxyList.coll
      • GenericProxyList.resolve_proxy()
    • generic_create()
    • generic_delete()
    • generic_fetch()
    • generic_fetch_list()
    • generic_fetch_old()
    • generic_get()
    • generic_proxy_sync()
  • stelar.client.group module
    • Group
      • Group.proxy_schema
    • GroupBase
      • GroupBase.add()
      • GroupBase.approval_status
      • GroupBase.created
      • GroupBase.datasets
      • GroupBase.description
      • GroupBase.get_members()
      • GroupBase.groups
      • GroupBase.image_url
      • GroupBase.is_organization
      • GroupBase.remove()
      • GroupBase.title
      • GroupBase.tools
      • GroupBase.users
      • GroupBase.workflows
    • MemberList
      • MemberList.to_df()
    • Organization
      • Organization.proxy_schema
  • stelar.client.knowgraph module
    • KnowledgeGraphAPI
  • stelar.client.license module
    • License
      • License.description
      • License.id
      • License.image_url
      • License.key
      • License.metadata_created
      • License.metadata_modified
      • License.open_data_approved
      • License.osi_approved
      • License.proxy_schema
      • License.title
      • License.url
    • LicenseCursor
    • LicensedProxy
      • LicensedProxy.license
      • LicensedProxy.license_id
  • stelar.client.lineage module
    • ENode
      • ENode.ent
      • ENode.id
      • ENode.incoming
      • ENode.lineage
      • ENode.outgoing
      • ENode.type
    • EResource
      • EResource.label
      • EResource.package_id
      • EResource.url
    • ETask
      • ETask.end_date
      • ETask.image
      • ETask.label
      • ETask.process_id
      • ETask.start_date
      • ETask.state
    • Lineage
      • Lineage.focus
  • stelar.client.model module
    • DuplicateEntryError
    • EntityNotFoundError
    • MissingParametersError
    • STELARUnknownError
  • stelar.client.mutils module
    • is_s3url()
    • s3spec_to_dict()
    • s3spec_to_pair()
    • s3spec_to_url()
  • stelar.client.named module
    • NamedProxy
      • NamedProxy.extras
      • NamedProxy.name
      • NamedProxy.state
      • NamedProxy.type
  • stelar.client.package module
    • PackageCursor
      • PackageCursor.default_organization
      • PackageCursor.search()
      • PackageCursor.with_tag()
    • PackageProxy
      • PackageProxy.add_relationship()
      • PackageProxy.add_resource()
      • PackageProxy.author
      • PackageProxy.author_email
      • PackageProxy.creator
      • PackageProxy.groups
      • PackageProxy.maintainer
      • PackageProxy.maintainer_email
      • PackageProxy.metadata_created
      • PackageProxy.metadata_modified
      • PackageProxy.notes
      • PackageProxy.organization
      • PackageProxy.private
      • PackageProxy.relationships
      • PackageProxy.resources
  • stelar.client.pdutils module
    • StelarDataFrameAccessor
      • StelarDataFrameAccessor.write_dataset()
    • StelarSeriesAccessor
      • StelarSeriesAccessor.getattr()
      • StelarSeriesAccessor.to_proxy_vec()
    • get_pandas_storage_options()
    • infer_format()
    • read_dataframe()
    • write_dataframe()
  • stelar.client.policy module
    • Policy
      • Policy.active
      • Policy.created_at
      • Policy.creator
      • Policy.id
      • Policy.policy_name
      • Policy.proxy_schema
      • Policy.spec
    • PolicyCursor
      • PolicyCursor.active
      • PolicyCursor.create()
  • stelar.client.process module
    • ExecStateField
      • ExecStateField.VALUES
    • Process
      • Process.creator
      • Process.end_date
      • Process.exec_state
      • Process.proxy_schema
      • Process.run()
      • Process.start_date
      • Process.tasks
      • Process.terminate()
      • Process.title
      • Process.url
      • Process.version
      • Process.workflow
    • ProcessCursor
  • stelar.client.relationship module
    • Rel
      • Rel.CHILD_OF
      • Rel.DEPENDENCY_OF
      • Rel.DEPENDS_ON
      • Rel.DERIVES_FROM
      • Rel.HAS_DERIVATION
      • Rel.LINKED_FROM
      • Rel.LINKS_TO
      • Rel.PARENT_OF
      • Rel.is_canonical()
      • Rel.peer()
    • RelProxy
      • RelProxy.add()
      • RelProxy.child_of
      • RelProxy.dependency_of
      • RelProxy.depends_on
      • RelProxy.derives_from
      • RelProxy.get()
      • RelProxy.has_derivation
      • RelProxy.linked_from
      • RelProxy.links_to
      • RelProxy.parent_of
      • RelProxy.remove()
      • RelProxy.subject_id
    • Relationship
      • Relationship.canonical()
      • Relationship.delete()
      • Relationship.exists()
      • Relationship.from_dict()
      • Relationship.from_triple()
      • Relationship.matches()
      • Relationship.object
      • Relationship.object_data()
      • Relationship.peer()
      • Relationship.set_comment()
      • Relationship.subject
      • Relationship.subject_data()
      • Relationship.to_dict()
    • Relationships
      • Relationships.delete()
      • Relationships.entities()
      • Relationships.from_api()
      • Relationships.matching()
      • Relationships.objects()
    • entity_data_matches()
  • stelar.client.reprstyle module
    • dataset_to_html()
    • resource_to_html()
  • stelar.client.resource module
    • ExtrasResourceProperty
      • ExtrasResourceProperty.convert_entity_to_proxy()
      • ExtrasResourceProperty.convert_proxy_to_entity()
      • ExtrasResourceProperty.convert_to_create()
    • PackageField
      • PackageField.proxy_type
    • PackageRef
      • PackageRef.ENTITIES
      • PackageRef.VALIDATOR_CLASS
      • PackageRef.proxy_types
      • PackageRef.registry_for()
    • Resource
      • Resource.cache_last_updated
      • Resource.cache_url
      • Resource.created
      • Resource.dataset
      • Resource.description
      • Resource.format
      • Resource.hash
      • Resource.id
      • Resource.last_modified
      • Resource.lineage()
      • Resource.metadata_modified
      • Resource.mimetype
      • Resource.mimetype_inner
      • Resource.name
      • Resource.open()
      • Resource.position
      • Resource.proxy_schema
      • Resource.proxy_sync()
      • Resource.read_dataframe()
      • Resource.resource_type
      • Resource.size
      • Resource.state
      • Resource.url
      • Resource.url_type
    • ResourceCursor
      • ResourceCursor.fetch()
      • ResourceCursor.fetch_list()
      • ResourceCursor.for_object()
      • ResourceCursor.search()
      • ResourceCursor.search_url()
  • stelar.client.s3 module
    • S3API
      • S3API.s3
      • S3API.s3_access_data()
      • S3API.s3fs()
      • S3API.s3fs_open()
  • stelar.client.spatial module
    • GeoJSON
      • GeoJSON.convert_to_entity()
      • GeoJSON.convert_to_proxy()
      • GeoJSON.default_value()
      • GeoJSON.repr_type()
      • GeoJSON.to_geojson()
  • stelar.client.task_spec module
    • TaskSpec
      • TaskSpec.d()
      • TaskSpec.from_json()
      • TaskSpec.i()
      • TaskSpec.is_external()
      • TaskSpec.o()
      • TaskSpec.p()
      • TaskSpec.process_inspec()
      • TaskSpec.process_inspec_entry()
      • TaskSpec.process_outspec()
      • TaskSpec.spec()
  • stelar.client.tasks module
    • Task
      • Task.abort()
      • Task.creator
      • Task.done
      • Task.end_date
      • Task.exec_state
      • Task.exit_job()
      • Task.fail()
      • Task.id
      • Task.image
      • Task.inputs
      • Task.is_external
      • Task.job_input
      • Task.jobs()
      • Task.logs()
      • Task.messages
      • Task.metrics
      • Task.outputs
      • Task.parameters
      • Task.printlog()
      • Task.process
      • Task.proxy_schema
      • Task.runtime
      • Task.signature
      • Task.start_date
      • Task.sync_state()
      • Task.tags
      • Task.tool
      • Task.wait()
    • TaskCursor
      • TaskCursor.create()
      • TaskCursor.created()
      • TaskCursor.failed()
      • TaskCursor.fetch()
      • TaskCursor.fetch_list()
      • TaskCursor.running()
      • TaskCursor.succeeded()
  • stelar.client.tool module
    • Image
      • Image.id
      • Image.is_manifest_list
      • Image.last_modified
      • Image.manifest_digest
      • Image.name
      • Image.reversion
      • Image.size
      • Image.start_ts
      • Image.tool
    • ImageRegistryToken
      • ImageRegistryToken.DATEFORMAT
      • ImageRegistryToken.created
      • ImageRegistryToken.expiration
      • ImageRegistryToken.id
      • ImageRegistryToken.last_accessed
      • ImageRegistryToken.proxy_schema
      • ImageRegistryToken.title
      • ImageRegistryToken.token
    • ImageRegistryTokenCursor
      • ImageRegistryTokenCursor.create()
    • ProfilesField
      • ProfilesField.convert_to_proxy()
      • ProfilesField.to_frozendict()
    • Tool
      • Tool.category
      • Tool.delete_profile()
      • Tool.get_image()
      • Tool.get_profile()
      • Tool.git_repository
      • Tool.images
      • Tool.inputs
      • Tool.outputs
      • Tool.parameters
      • Tool.profiles
      • Tool.programming_language
      • Tool.proxy_schema
      • Tool.repository
      • Tool.set_profile()
      • Tool.task_spec()
      • Tool.update_profile()
      • Tool.version
    • ToolCategoryField
      • ToolCategoryField.VALUES
    • ToolCursor
    • ToolProfile
      • ToolProfile.backoff_limit
      • ToolProfile.cpu_limit
      • ToolProfile.cpu_request
      • ToolProfile.description
      • ToolProfile.image
      • ToolProfile.image_pull_policy
      • ToolProfile.image_pull_secrets
      • ToolProfile.memory_limit
      • ToolProfile.memory_request
      • ToolProfile.restart_policy
      • ToolProfile.to_dict()
      • ToolProfile.ttl_seconds_after_finished
      • ToolProfile.validate()
      • ToolProfile.validate_backoff_limit()
      • ToolProfile.validate_cpu_limit()
      • ToolProfile.validate_cpu_request()
      • ToolProfile.validate_image()
      • ToolProfile.validate_image_pull_policy()
      • ToolProfile.validate_image_pull_secrets()
      • ToolProfile.validate_memory_limit()
      • ToolProfile.validate_memory_request()
      • ToolProfile.validate_restart_policy()
      • ToolProfile.validate_ttl_seconds_after_finished()
  • stelar.client.user module
    • User
      • User.active
      • User.add_role()
      • User.append_roles()
      • User.email
      • User.email_verified
      • User.first_name
      • User.fullname
      • User.id
      • User.joined_date
      • User.last_name
      • User.proxy_schema
      • User.remove_role()
      • User.roles
      • User.set_roles()
      • User.username
    • UserCursor
      • UserCursor.create()
      • UserCursor.current_user
      • UserCursor.fetch()
      • UserCursor.fetch_list()
      • UserCursor.roles()
  • stelar.client.utils module
    • client_for()
    • convert_proxy_id_to_str()
  • stelar.client.vocab module
    • Tag
      • Tag.get_tagged_datasets()
      • Tag.id
      • Tag.name
      • Tag.proxy_schema
      • Tag.tagspec
      • Tag.vocabulary
    • TagCursor
    • Vocabulary
      • Vocabulary.add_tags()
      • Vocabulary.id
      • Vocabulary.name
      • Vocabulary.new()
      • Vocabulary.proxy_schema
      • Vocabulary.proxy_sync()
      • Vocabulary.tag_map
      • Vocabulary.tagnames
      • Vocabulary.tags
      • Vocabulary.tagspecs
    • VocabularyCursor
  • stelar.client.wfapi module
    • WorkflowsAPI
  • stelar.client.workflows module
    • Workflow
      • Workflow.executor
      • Workflow.proxy_schema
      • Workflow.repository
      • Workflow.title
      • Workflow.version
  • Module contents