Brainrot-Stocks 0.1.1

Get stock data with unwanted brainrot in your Python app.

Brainrot-Stocks

An exercise to create a Python package, build it, test it, distribute it, and use it. See instructions for details.

This package was created by generally following the Packaging Python Projects with the addition of some pipenv setup to manage virtual environments.

Project Description

Brainrot-Stocks is a Python package designed for handling financial data. It includes modules for managing stock quotes, performing various operations on financial data, and engaging learning experiences.

Link to Package on PYPI

https://pypi.org/project/Brainrot-Stocks/0.1.0/#description

Team members

Reyhan Abdul Quayum	Rashed Alneyadi	Sia Chen	Yu Zhang	Chloe Han

Project Structure

• src/Financiers
  Contains the main modules:

  • quotes.py: Handles operations related to stock quotes.
  • stock.py: Manages stock data and related functionality.

• tests
  Contains test files for validating the code.

  • test_stock.py: Tests the stock.py module.

How to install and use this package

Prerequisites: have latest versions of pip and python installed on your environment.

1. Navigate to your project directory. Create a virtual environment using pipenv, and install the latest version of the package with the following command:

pip install pipenv
pipenv install Brainrot-Stocks

And before moving onto the next step, activate the virtual environment:

pipenv shell

2. Import the package using the following command inside the file:

from Financiers.stock import Stock

Then, create an instance of Stock class:

stock = Stock()

And you're ready to go! Refer to this example file to see the example usage of package functions inside the code.

3. Run the program (replace <example_file> with your actual file name):

python <example_file>.py

Contribute to the project

Prerequisites: have latest versions of pip and python installed on your environment.

Environment Setup

1. Clone the repository:

git clone https://github.com/software-students-fall2024/3-python-package-financeeers.git
cd 3-python-package-financeeers

2. Install pipenv:

If pipenv has not been installed, install using the following command:

pip install pipenv

3. Create and Activate virtual environment:

pipenv install
pipenv shell

4. Add .env file: create .env file in the root directory of the project, and add the following content:

ALPHAVANTAGE_API_KEY = <api_key>

Replace <api_key> with the actual api key, which will be delivered to the admins via discord.

Make contribution

1. Modify & Run the file:

Make changes you want to make, and run the files. For example, if you want to run stock.py, run the following command:

python src/Financiers/stock.py

Test & Build

Make sure you are in the virtual environment by running the following command:

pipenv shell

1. Test

Run all unit tests with the following command:

pytest

2. Build

Build the package using the following command:

python -m build

Then, the artifacts will be produced at dist/.

If you want to exit the virtual environment, use this comand:

exit