Skip to main content

Nyctibius is a Python package for gathering and consolidating socio-demographic data.

Project description

Nyctibius - Streamlining sociodemographic data harmonizing.

en es License: MIT R-CMD-check Codecov test coverage lifecycle-concept

The Python package Nyctibius is designed to streamline the complex task of gathering and consolidating sociodemographic data from various sources into a cohesive relational database. Nyctibius empowers users to effortlessly unify custom data sets from diverse socio-demographic sources, ensuring that they can work with up-to-date and comprehensive information in a seamless manner. This package facilitates the process of creating a harmonized repository of socio-demographic data, simplifying data management and analysis for users across various domains.

Features

  • Seamlessly retrieve data from online data sources through web scraping.
  • Effortlessly extract data from diverse sources, consolidating it into a cohesive relational database.
  • Conduct precise queries and apply transformations to meet specific criteria.
  • Effectively manage data inconsistencies and discrepancies for enhanced accuracy.
  • Support for various data formats, including .csv, .xlsx, .xls, .txt, and zip files, ensuring versatility in sourcing information.

Installation

For full documentation, please refer to the Nyctibius documentation.

You can install the Nyctibius package using pip. Make sure you have Python 3.x installed on your system; the package requires Python version 3.7 or higher.

pip install nyctibius

Usage

To use the Nyctibius package, follow these steps:

  1. Import the package in your Python script:

    from nyctibius import Harmonizer
    
  2. Create an instance of the Harmonizer class:

    harmonizer = Harmonizer()
    
  3. Extract data from online sources and create a list of data information:

    url = 'https://www.example.com'
    depth = 0
    ext = 'csv'
    list_datainfo = harmonizer.extract(url=url, depth=depth, ext=ext)
    harmonizer = Harmonizer(list_datainfo)
    
  4. Load the data from the list of data information and merge it into a relational database:

    results = harmonizer.load()
    
  5. Import the modifier module and create an instance of the Modifier class:

    from nyctibius.db.modifier import Modifier
    modifier = Modifier(db_path='../../data/output/nyctibius.db')
    
  6. Perfom modifications:

    tables = modifier.get_tables()
    print(tables)
    
  7. Import the querier module and create an instance of the Querier class:

    from nyctibius.db.querier import Querier
    querier = Querier(db_path='data/output/nyctibius.db')
    
  8. Perform queries:

    df = querier.select(table="Estructura CHC_2017").execute()
    print(df)
    

Supported Data Sources

The package supports the following sources:

  • Colombian microdata links from National Administrative Department of Statistics (DANE)
  • Local files
  • Open data sources

Please note that accessing data from these organizations may require authentication or specific credentials. Make sure you have the necessary permissions before using the library.

License

The Nyctibius package is open-source and released under the MIT License. Feel free to use, modify, and distribute this library in accordance with the terms of the license.

Acknowledgements

We would like to thank the following entities for providing the data used and the economic financial support for the development of this package:

  • National Administrative Department of Statistics (DANE)
  • Barcelona Supercomputing Center (BSC)
  • Universidad de los Andes

Contact

For any questions, suggestions, or feedback regarding the package please contact:

Erick lozano, Email: es.lozano@uniandes.edu.co

Diego Irreño, Email: dirreno@unal.edu.co

Disclaimer

This library is not officially affiliated with or endorsed by any of the mentioned official organizations. The data provided by this library is sourced from publicly available information and may not always reflect the most current or accurate data. Please verify the information with the respective official sources for critical use cases.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nyctibius-0.0.6.tar.gz (27.6 kB view details)

Uploaded Source

Built Distribution

nyctibius-0.0.6-py3-none-any.whl (34.7 kB view details)

Uploaded Python 3

File details

Details for the file nyctibius-0.0.6.tar.gz.

File metadata

  • Download URL: nyctibius-0.0.6.tar.gz
  • Upload date:
  • Size: 27.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for nyctibius-0.0.6.tar.gz
Algorithm Hash digest
SHA256 a9322ad66fd5cbbf4149776d36d56be4d94c5f69269cc46041d1129689b9403d
MD5 eed0ae21b3fd6f2f3f4b1ed89d642428
BLAKE2b-256 2a205dd58206f4fb3cceb86efb2937e12d5797f1e04d73106ab642d1ab79e517

See more details on using hashes here.

File details

Details for the file nyctibius-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: nyctibius-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 34.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for nyctibius-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 1cca83c68a8e7abd6b927a0dfed0b113c55493be0fe2c08a5a775e3e836058f4
MD5 fb6150f3c3a7f6b907ec4af1d39d7233
BLAKE2b-256 c7e8444789b661b701195b8605453fb420142bfa9e595327614213f04969b1c0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page