Higher Institutions NG is a project aimed at providing comprehensive information about Nigerian higher institutions, including universities, colleges, and polytechnics. The project consists of several components, including resources, npm package, and PyPI package.
The resources
directory contains all the essential data and scripts necessary for processing and managing information about Nigerian higher institutions. It includes:
NARR
: This directory contains the main data source, a CSV file namedNARR institution.csv
, which contains detailed information about Nigerian higher institutions.higher_institutions.py
: This Python script processes the CSV data and converts it into JSON format.
The npm
directory contains the source code and resources for the npm package higher-institutions-ng
, which provides access to information about Nigerian higher institutions for JavaScript projects. It includes:
src
: This directory contains the TypeScript source code for the npm package.Nigerian Higher Institutions.json
: This JSON file contains the processed data about Nigerian higher institutions, ready for use in JavaScript projects.README.md
: The README file for the npm package, providing usage instructions and other relevant information.
The npm package is published and available for installation via the npm package manager.
The pypi
directory contains the source code and resources for the PyPI package higher-institutions-ng
, which provides access to information about Nigerian higher institutions for Python projects. It includes:
src
: This directory contains the Python source code for the PyPI package.Nigerian Higher Institutions.json
: This JSON file contains the processed data about Nigerian higher institutions, ready for use in Python projects.README.md
: The README file for the PyPI package, providing usage instructions and other relevant information.
The PyPI package is published and available for installation via the pip package manager.
To use the project components, follow these steps:
- Ensure you have the necessary dependencies installed for the npm and PyPI packages.
- Use the npm package
higher-institutions-ng
in your JavaScript projects by installing it via npm. - Use the PyPI package
higher-institutions-ng
in your Python projects by installing it via pip. - Refer to the respective README files in the
npm
andpypi
directories for detailed usage instructions.
Contributions to this project are welcome! If you'd like to contribute, please fork the repository, make your changes, and submit a pull request.