Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.25 KB

README.md

File metadata and controls

51 lines (34 loc) · 1.25 KB

Application Programming Interface (API) - It's a set of rules and commands that software systems use to communicate with each other. A bridge between software systems 🌉

This is a data collection project using an API. The project regards collecting data from the News API. You'll need an API key from the News API. You can sign up for free.

Installation

Use the package manager pip to install the following packages.

NB. You can install the packages in a virtual environment or globally. We used python 3.10 for this example.

Virtual Environment

pip install virtualenv

Activate Virtual Environment

source .venv/bin/activate
pip install requests polars pandas pyarrow

Usage

We use a Makefile to run the project. The Makefile contains the following commands:

make install

Activate the virtual environment and run the command.

. .venv/bin/activate

This command installs the required packages.

make run

This command runs the project.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

Creative Commons Zero v1.0 Universal