diff --git a/README.md b/README.md index 49e9834..044cde2 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,22 @@ Install vizBlend using pip: ``` pip install vizBlend ``` + +# Learning Purpose + +While this repo is open-sourced for any developer, it intends to teach aspiring data analysts or even data scientists who cannot have full control over their coding cycle. With a simple mission: create visualizations and append them in one interactive report, you can take your learning curve up to include useful skills: +* Write unit and integration tests with edge cases to ensure your code is not error-prone. + +* Write CI/CD workflows to run on every push or pull request to ensure the newly committed code is compatible enough. + +* Creating, managing and deploying your packaged code to PyPi so that you can simply run `pip install ` and start using it. + + + ##### Useful Resources + + These are the resources that helped this work appear + * [GitHub Actions for Python Packages: How to Automate Releases to PyPi](https://www.youtube.com/watch?v=NMQwzI9hprg&ab_channel=ArjanCodes) + + * [Automated Python Unit Testing Made Easy with Pytest and GitHub Actions](https://pytest-with-eric.com/integrations/pytest-github-actions/) + + * [Building and testing Python | Official GitHub Actions Docs](https://docs.github.com/en/actions/use-cases-and-examples/building-and-testing/building-and-testing-python) \ No newline at end of file