update

nhanes_pytool_api/setup.py

@@ -18,6 +18,8 @@
         "License :: OSI Approved :: MIT License",
         "Programming Language :: Python :: 3.8",
         "Operating System :: OS Independent",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        "Topic :: Scientific/Engineering :: Information Analysis",
     ],
     packages=find_packages(where="src"),
     package_dir={"": "src"},

nhanes_pytool_api/src/nhanes_pytool_api.egg-info/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.1
+Name: nhanes-pytool-api
+Version: 0.1.0
+Summary: A tool for programmatic access to NHANES downloadable datasets
+Home-page: https://github.com/kkrusere/NHANES-pyTOOL-API
+Author: Kuzi Rusere
+Author-email: kkrusere@gmail.com
+Project-URL: Documentation, https://kkrusere.github.io/NHANES-pyTOOL-API/
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: numpy
+Requires-Dist: pandas
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+
+# NHANES pyTOOL API
+
+The NHANES pyTOOL 'API' is a Python library designed to simplify the process of accessing and analyzing data from the National Health and Nutrition Examination Survey (NHANES). NHANES is a program of studies conducted by the National Center for Health Statistics (NCHS), part of the Centers for Disease Control and Prevention (CDC), to assess the health and nutritional status of adults and children in the United States.
+
+This tool provides an easy-to-use interface for retrieving NHANES datasets, allowing researchers, data science professionals, health professionals, developers and other stakeholders to explore NHANES data efficiently, enabling a wide range of health-related analyses and applications.
+
+## Features
+
+- **List Data Categories:** Retrieve a list of available NHANES data categories.
+- **List Cycle Years:** Get a list of available NHANES cycle years.
+- **Retrieve Variable Tables:** Fetch variable tables for specific data categories.
+- **Get Data File Descriptions:** Obtain unique data file descriptions for a given data category and cycle years.
+- **Retrieve Data:** Fetch data for specific data categories, cycle years, and data file descriptions.
+- **Join Data Files:** Join data files based on common variables.
+- **Find Common and Uncommon Variables:** Identify common and uncommon variables across multiple cycle years.
+
+
+## Installation
+
+To install the NHANES pyTOOL API, use `pip`:
+
+```bash
+pip install nhanes_pytool_api
+```
+
+
+
+# Important Note
+
+**Attention:** In the current version of the NHANES pyTOOL API (version X.X.X), we do not provide a command-line interface (CLI) for direct use from the terminal. This means that you cannot run the API from the command line to access NHANES data. Instead, the API is designed for use as a library in Python scripts or applications.
+###### Future Updates - We are continuously improving the NHANES Data API, and in future versions, we may consider adding a command-line interface for easier interaction with the API from the terminal. Until then, please use the API in your Python scripts or applications.
+
+
+## Documentation
+
+For detailed information on how to use the NHANES pyTOOL API, check out the [documentation](https://kkrusere.github.io/NHANES-pyTOOL-API/).
+
+## Contributing
+
+Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/kkrusere/NHANES-pyTOOL-API/blob/main/LICENSE.txt) file for details.

nhanes_pytool_api/src/nhanes_pytool_api.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+LICENSE.txt
+README.md
+setup.py
+src/nhanes_pytool_api.egg-info/PKG-INFO
+src/nhanes_pytool_api.egg-info/SOURCES.txt
+src/nhanes_pytool_api.egg-info/dependency_links.txt
+src/nhanes_pytool_api.egg-info/requires.txt
+src/nhanes_pytool_api.egg-info/top_level.txt
+tests/test_nhanes_data_api.py

nhanes_pytool_api/src/nhanes_pytool_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

nhanes_pytool_api/src/nhanes_pytool_api.egg-info/requires.txt

@@ -0,0 +1,5 @@
+numpy
+pandas
+
+[test]
+pytest

nhanes_pytool_api/src/nhanes_pytool_api.egg-info/top_level.txt

@@ -0,0 +1 @@
+