Contents Menu Expand Light mode Dark mode Auto light/dark mode
ipumspy
Logo
ipumspy

User Guide

  • Getting Started
  • IPUMS API
    • Microdata Extracts
    • Aggregate Data Extracts
  • Reading IPUMS Data
  • Command Line Interface

Reference

  • API
    • REST API Interface
      • ipumspy.api.IpumsApiClient
        • ipumspy.api.IpumsApiClient.__init__
        • ipumspy.api.IpumsApiClient.download_extract
        • ipumspy.api.IpumsApiClient.extract_is_expired
        • ipumspy.api.IpumsApiClient.extract_status
        • ipumspy.api.IpumsApiClient.get
        • ipumspy.api.IpumsApiClient.get_all_sample_info
        • ipumspy.api.IpumsApiClient.get_extract_by_id
        • ipumspy.api.IpumsApiClient.get_extract_history
        • ipumspy.api.IpumsApiClient.get_extract_info
        • ipumspy.api.IpumsApiClient.get_metadata
        • ipumspy.api.IpumsApiClient.get_metadata_catalog
        • ipumspy.api.IpumsApiClient.get_previous_extracts
        • ipumspy.api.IpumsApiClient.post
        • ipumspy.api.IpumsApiClient.request
        • ipumspy.api.IpumsApiClient.submit_extract
        • ipumspy.api.IpumsApiClient.wait_for_extract
      • ipumspy.api.BaseExtract
        • ipumspy.api.BaseExtract.__init__
        • ipumspy.api.BaseExtract.build
        • ipumspy.api.BaseExtract.extract_api_version
      • ipumspy.api.MicrodataExtract
        • ipumspy.api.MicrodataExtract.__init__
        • ipumspy.api.MicrodataExtract.add_data_quality_flags
        • ipumspy.api.MicrodataExtract.adjust_monetary_values
        • ipumspy.api.MicrodataExtract.attach_characteristics
        • ipumspy.api.MicrodataExtract.build
        • ipumspy.api.MicrodataExtract.select_cases
      • ipumspy.api.AggregateDataExtract
        • ipumspy.api.AggregateDataExtract.__init__
        • ipumspy.api.AggregateDataExtract.build
      • ipumspy.api.Variable
        • ipumspy.api.Variable.__init__
        • ipumspy.api.Variable.build
      • ipumspy.api.Sample
        • ipumspy.api.Sample.__init__
        • ipumspy.api.Sample.build
      • ipumspy.api.TimeUseVariable
        • ipumspy.api.TimeUseVariable.__init__
        • ipumspy.api.TimeUseVariable.build
      • ipumspy.api.NhgisDataset
        • ipumspy.api.NhgisDataset.__init__
        • ipumspy.api.NhgisDataset.build
      • ipumspy.api.IhgisDataset
        • ipumspy.api.IhgisDataset.__init__
        • ipumspy.api.IhgisDataset.build
      • ipumspy.api.TimeSeriesTable
        • ipumspy.api.TimeSeriesTable.__init__
        • ipumspy.api.TimeSeriesTable.build
      • ipumspy.api.Shapefile
        • ipumspy.api.Shapefile.__init__
        • ipumspy.api.Shapefile.build
      • ipumspy.api.extract_from_dict
      • ipumspy.api.extract_to_dict
      • ipumspy.api.extract.save_extract_as_json
      • ipumspy.api.extract.define_extract_from_json
      • ipumspy.api.metadata.NhgisDatasetMetadata
        • ipumspy.api.metadata.NhgisDatasetMetadata.__init__
      • ipumspy.api.metadata.IhgisDatasetMetadata
        • ipumspy.api.metadata.IhgisDatasetMetadata.__init__
      • ipumspy.api.metadata.NhgisDataTableMetadata
        • ipumspy.api.metadata.NhgisDataTableMetadata.__init__
      • ipumspy.api.metadata.IhgisDataTableMetadata
        • ipumspy.api.metadata.IhgisDataTableMetadata.__init__
      • ipumspy.api.metadata.TimeSeriesTableMetadata
        • ipumspy.api.metadata.TimeSeriesTableMetadata.__init__
      • ipumspy.api.exceptions.IpumsApiException
      • ipumspy.api.exceptions.TransientIpumsApiException
      • ipumspy.api.exceptions.IpumsExtractNotReady
      • ipumspy.api.exceptions.IpumsTimeoutException
      • ipumspy.api.exceptions.IpumsAPIAuthenticationError
      • ipumspy.api.exceptions.BadIpumsApiRequest
      • ipumspy.api.exceptions.IpumsExtractNotSubmitted
      • ipumspy.api.exceptions.IpumsApiRateLimitException
    • DDI
      • ipumspy.ddi.Codebook
        • ipumspy.ddi.Codebook.__init__
        • ipumspy.ddi.Codebook.get_all_types
        • ipumspy.ddi.Codebook.get_variable_info
        • ipumspy.ddi.Codebook.read
      • ipumspy.ddi.FileDescription
        • ipumspy.ddi.FileDescription.__init__
        • ipumspy.ddi.FileDescription.read
      • ipumspy.ddi.VariableDescription
        • ipumspy.ddi.VariableDescription.__init__
        • ipumspy.ddi.VariableDescription.read
    • readers
      • ipumspy.readers.read_ipums_ddi
      • ipumspy.readers.read_microdata
      • ipumspy.readers.read_microdata_chunked
      • ipumspy.readers.read_hierarchical_microdata
    • noextract
      • ipumspy.noextract.read_noextract_codebook
      • ipumspy.noextract.download_noextract_data
    • utilities
      • ipumspy.utilities.tabulate

Community

  • Contributing

Project History

  • Change Log
Back to top

DDI#

ipumspy.ddi.Codebook

A class representing an XML codebook downloaded from IPUMS

ipumspy.ddi.FileDescription

In the IPUMS DDI, the file has its own particular description.

ipumspy.ddi.VariableDescription

Individual variables are described in the DDI.

Next
ipumspy.ddi.Codebook
Previous
ipumspy.api.exceptions.IpumsApiRateLimitException
Copyright © 2021, Regents of the University of Minnesota
Made with Sphinx and @pradyunsg's Furo