Skip to content

Commit

Permalink
Update README, and organize the repo
Browse files Browse the repository at this point in the history
  • Loading branch information
DrSaadLa committed Dec 25, 2023
1 parent 68303f1 commit b951a88
Show file tree
Hide file tree
Showing 7 changed files with 101 additions and 1 deletion.
102 changes: 101 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,102 @@
# Polars-Learning-Path
Polars Learning Path

Welcome to the Polars-Learning-Path repository! This repository is dedicated to providing resources, tutorials, and examples for learning and working with Polars, a fast DataFrame library in Rust and Python. Our goal is to help users of all levels gain proficiency in using Polars for data manipulation and analysis.

## About Polars

Polars is a DataFrame library written in Rust, offering high performance and efficient data processing capabilities. It is also available in Python, providing an easy-to-use interface while leveraging Rust's speed.

For more information on contributing to this repository, please see the [Contributing](#contributing) section.

## Repository Structure

- `Tutorials/`: Contains step-by-step guides that cover various aspects of Polars, providing a comprehensive learning experience.
- `Examples/`: Offers practical examples that demonstrate the use of Polars in a variety of scenarios, showcasing its capabilities.
- `Practice/`: Includes exercises designed to help practice and reinforce Polars skills, catering to different levels of proficiency.
- `Projects/`: Features hands-on projects with real-world data, aimed at mastering Polars through applied learning.
- `Datasets/`: Provides sample datasets used within tutorials, examples, and projects, aiding in practical exercises and demonstrations.
- `Scripts/`: Contains utility scripts for data processing and analysis, complementing the learning material in other directories.


# Maintainer

This repository is currently maintained by **Dr.Saad Laouadi**. If you have any questions, feedback, or suggestions, feel free to reach out or open an issue.

- **Name:** **Dr Saad Laouadi**
- **GitHub:** [![GitHub](https://img.icons8.com/fluent/48/000000/github.png)](https://github.com/qcversity)

- **LinkedIn:** [![LinkedIn](https://img.icons8.com/color/48/000000/linkedin.png)](https://www.linkedin.com/in/saad-laouadi/)
- **Email:** [![Email](https://img.icons8.com/fluent/48/000000/mail.png)](mailto:[email protected])


- [Introduction](#polars-learning-path)
- [Tutorials](#tutorials)
- [Course Setup](#course-setup)
- [Environment Setup with venv](Tutorials/00.%20Course%20Setup/01_Environment%20Setup%20with%20venv.md)
- [Environment Setup with conda](Tutorials/00.%20Course%20Setup/02_Environment%20Setup%20with%20conda.md)
- [Environment Setup with mamba](Tutorials/00.%20Course%20Setup/03_Environment%20Setup%20with%20mamba.md)
- [Polars Vs Pandas](#polars-vs-pandas)
- [Pandas Vs Polars: Pandas](Tutorials/01.%20Polars%20Vs%20Pandas/Pandas%20Vs%20Polars%20Pandas.ipynb)
- [Polars Vs Pandas: Polars](Tutorials/01.%20Polars%20Vs%20Pandas/Polars%20Vs%20Pandas%20Polars.ipynb)
- [Reading Data](#reading-data)
- [Reading Plain Text Data](Tutorials/02.%20Reading%20Data/01.%20Reading%20Plain%20Text%20Data.ipynb)
- [Examples](#examples)
- [Projects](#projects)
- [Scripts](#scripts)
- [Datasets](#datasets)
- [Presentation for Polars](#presentation-for-polars)
- [Download Data Notebook](downlaod_data.ipynb)
- [Download Datasets Script](download_datasets.py)


## Getting Started

To get started with this repository, clone it to your local machine using:

```bash
git clone https://github.com/your-username/Polars-Learning-Path.git
```

## Prerequisites

Ensure you have Python installed on your system. You can download Python from python.org. Additionally, you'll need to install Polars. You can install it via pip:

```
pip install polars
```

## Running the Examples

To run the examples, navigate to the examples/ directory and execute the Python scripts:

```bash
cd Polars-Learning-Path/examples/
python example_script.py
```

## Contributing

We welcome contributions to the Polars-Learning-Path repository! Whether it's adding new examples, improving tutorials, or fixing bugs, your contributions are greatly appreciated.

### To contribute:

1. Fork the repository.
2. Create a new branch for your feature (`git checkout -b feature/NewFeature`).
3. Commit your changes (`git commit -m 'Add some NewFeature'`).
4. Push to the branch (`git push origin feature/NewFeature`).
5. Open a pull request.


## Acknowledgements

- [Polars GitHub Repository](https://github.com/pola-rs/polars)
- [Polars official documentation](https://pola-rs.github.io/polars/py-polars/html/index.html)



### License

-----

![](https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png)
This work is licensed under [Attribution-NonCommercial-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-nc-sa/4.0/?ref=chooser-v1)

0 comments on commit b951a88

Please sign in to comment.