Update

kkrusere · Oct 21, 2023 · 46cf934 · 46cf934
1 parent 52b186c
commit 46cf934
Show file tree

Hide file tree

Showing 8 changed files with 101 additions and 4 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -40,7 +40,7 @@ This 'API' provides an easy-to-use interface for retrieving NHANES datasets, all
 To install the NHANES Data API, you can use pip:
 
 ```bash
-pip install nhanes_data_api
+pip install nhanes_pytool_api
 ```
 ### 2.2 Quick Start <a name="quick-start"></a>
 You can get started quickly with the NHANES Data API by following these steps:
@@ -324,15 +324,15 @@ Here are some common error messages you may encounter when using the NHANES Data
 
 ## Additional Resources
 
-For more details on how to use the NHANES Data API, please refer to the official API documentation on our GitHub repository: API [Documentation](https://kkrusere.github.io/NHANES-Data-API/).
+For more details on how to use the NHANES Data API, please refer to the official API documentation on our GitHub repository: API [Documentation](https://kkrusere.github.io/NHANES-pyTOOL-API/).
 
-For reporting issues or requesting new features, please visit our [Bug Tracker](https://github.com/kkrusere/NHANES-Data-API/blob/main/issues/NHANE-DATA-API_issues.md).
+For reporting issues or requesting new features, please visit our [Bug Tracker](https://github.com/kkrusere/NHANES-pyTOOL-API/blob/main/issues/NHANE-pyTOOL-API_issues.md).
 
 ## 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-Data-API/blob/main/LICENSE.txt) file for details.
+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.
 
diff --git a/nhanes_pytool_api/LICENSE.txt b/nhanes_pytool_api/LICENSE.txt
@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2023 kuzirusere
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/nhanes_pytool_api/README.md b/nhanes_pytool_api/README.md
@@ -0,0 +1,44 @@
+# NHANES Data API
+
+The NHANES Data '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 'API' 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 Data API, use `pip`:
+
+```bash
+pip install nhanes_pytool_api
+```
+
+
+
+# Important Note
+
+**Attention:** In the current version of the NHANES Data 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 Data 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.
diff --git a/nhanes_pytool_api/setup.py b/nhanes_pytool_api/setup.py
@@ -0,0 +1,33 @@
+from setuptools import setup, find_packages
+
+# Read the long description from a file (if available)
+with open("README.md", "r") as readme_file:
+    long_description = readme_file.read()
+
+setup(
+    name="nhanes_pytool_api",
+    version="0.1.0",
+    author="Kuzi Rusere",
+    author_email="kkrusere@gmail.com",
+    description="A tool for programmatic access to NHANES downloadable datasets",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/kkrusere/NHANES-pyTOOL-API",
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3.8",
+        "Operating System :: OS Independent",
+    ],
+    packages=find_packages(where="src"),
+    package_dir={"": "src"},
+    python_requires=">=3.8",
+    install_requires=[
+        "numpy",
+        "pandas",
+    ],
+    extras_require={
+        'test': ['pytest']
+    },
+    project_urls={"Documentation": "https://kkrusere.github.io/NHANES-pyTOOL-API/"}
+)
diff --git a/nhanes_pytool_api/src/__init__.py b/nhanes_pytool_api/src/__init__.py
diff --git a/nhanes_pytool_api/src/nhanes_data_api.py b/nhanes_pytool_api/src/nhanes_data_api.py
diff --git a/nhanes_pytool_api/tests/__init__.py b/nhanes_pytool_api/tests/__init__.py
diff --git a/nhanes_pytool_api/tests/test_nhanes_data_api.py b/nhanes_pytool_api/tests/test_nhanes_data_api.py