Skip to content

Commit

Permalink
Merge pull request #15 from MahmoudHousam/update_readme
Browse files Browse the repository at this point in the history
add learning purpose
  • Loading branch information
MahmoudHousam authored Dec 15, 2024
2 parents aef7446 + 45f4b36 commit ba16911
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <package_name>` 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)

0 comments on commit ba16911

Please sign in to comment.