ubc-mds/stock_analyzer

DSCI 524 Group 20: Python package that analyzes stocks!

stock_analyzer's Issues

Make sure that the tests cover all branches

moving average function

Manage issues

• Project boards & Milestones
• Assign issue to each member

Edit CONDUCT.md to include the code of conduct for contributing to your project

visualize functions

Agree upon collaboration strategy (Github flow) and edit on CONTRIBUTING.md

Function specification brainstorming （From William）

• Data visualization
• Log-transformation
• Moving average, some summary statistics
• Exponential smoothing
• Prediction (if time permits)

Use proper grammar and full sentences throughout the project, especially in your README

Docstrings for functions

• moving average (Tingyu Zhang)
• exponential smoothing (Sicheng Sun)
• summary statistics (Mark (Kangyu) Wang)
• Data visualization (William(Yihang) Xu)

writing codes for summary statistics

• main body of the function
• unit tests

Outline the package you would like to build in the README.md

• a summary paragraph that describes the project at a high level
• a bulleted list of the functions (and datasets if applicable) that will be included in the package
• a paragraph describing where your packages fit into the Python ecosystem

Saturday Final Review Meeting at 2:30pm

summary statistics function

Create project structure

Check whether the code passes the unit tests you have written using the pytest package

exponential smoothing function

Create project structure for the R project

writing codes for moving average

• main body of the function
• unit tests

Edit CONTRIBUTORS.md to add the contributor names (the students on the teams)

writing codes for exponential smoothing

• main body of the function
• unit tests

Team work contract

writing codes for data visualizations

• main body of the function
• unit tests

Documentation

We are experiencing technical difficulties with the display of the submodule. The docs badge showed pass with no issue after we created Read the Docs build. The docstrings were showing perfectly fine on all our local machines. Tiffany is helping us debug. Updates to be continued.

Exception handling

• summary statistics
• moving average
• exponential smoothing
• data visualizaions

Github actions workflow for continuous integration

A couple things you might need to change in your .github/workflows/build.yml file:

• Ensure the deployment branch (typically the main branch) is correctly specified on lines 7 & 10
• Ensure that the correct Python version is listed on lines 21 and 24 (it should match the version in your pyproject.toml file)

License checklist

Friday 1pm Meeting Zoom Link

https://us04web.zoom.us/j/79921485252?pwd=ZVJLbXJwUHlkRWJhQlNoemEvVFpyUT09

passcode: Z5jTNc

GitHub actions workflow for continuous deployment

A couple things you might need to change in your .github/workflows/deploy.yml file:

• Ensure the deployment branch (typically the main branch) is correctly specified on lines 7
• Ensure that the correct Python version is listed on line 14 (it should match the version in your pyproject.toml file)