MasamioNakada/wikiframe

A python package

WikiFrame

Convert all csv files in a folder to a diccionary of dataframe and more!.
Explore the docs »

Table of Contents

1. About The Project
2. Installation
3. Usage
4. Contributing
5. License

About The Project

WikiFrame scan all the .csv files in a folder and convert into a diccionary of dataframe, This package accept different csv delimiter and encodings. Also if you want to add transform dataframe-functions, you can add it!.

(back to top)

Installation

1. Install from PyPI

   pip install wikiframe

(back to top)

Usage

Extractor:

This function will extract all the csv files in the folder and convert them to a dictionary of dataframe.

    Parameters:
    -----------
    func : A list of functions that will be applied to the dataframe. (e.g. [func1, func2, func3])
    verbose : If True, will print the name of the dataframe that is transformed. (default False)

    Returns:
    --------
    data_dict : A dictionary of dataframe.

    Notes:
    ------
    The order of the dataframe in the dictionary is the same as the order of the csv files in the folder.
    func could be a list of functions or a single function.

Example:

from wiki_tools import Extractor # Import the Extractor function

extractor = Extractor(path='path/to/folder') # path to folder with csv files

data_dictonary = extractor.extract_from_csv() # extract all csv files on a folder and convert into a dictionary of dataframe

Say:

A cow helper function to say something Parameters: ----------- something: A string to say in console

Example:

    from wiki_tools import Say # Import the Say function    
    say = Say('Hello World') # Say something
    say.cow_says_good() # Say something in cow speak
    say.cow_says_error() # Say something in cow speak

Output:

< Hello World >
 -------------
        \   ^__^
         \  (oo)\_______
            (__)\ good🙈 )\/\
                ||----w |
                ||     ||
 _____________
< Hello World >
 -------------
        \   ^__^
         \  (oo)\_______
            (__)\ good🙈 )\/\
                ||----w |
                ||     ||

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)