report-manager


Namereport-manager JSON
Version 0.7.0 PyPI version JSON
download
home_pagehttps://github.com/Knuckles-Team/report-manager
SummaryManage your reports
upload_time2022-12-23 19:03:45
maintainer
docs_urlNone
authorAudel Rouhi
requires_python
licenseUnlicense
keywords
VCS
bugtrack_url
requirements scikit-learn pandas matplotlib pandas_profiling scipy numpy xlsxwriter tabulate ipywidgets
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Report Manager
*Version: 0.7.0*

Manage your reports
- Merge reports based off specified columns
- Generate analysis on data set
- Pandas profiling

### Usage:
| Short Flag | Long Flag | Description                                         |
|------------| ------|-----------------------------------------------------|
| -h         | --help | See Usage                                           |
| -f         | --files | File(s) to be read (Comma separated)     |
| -n         | --name | Name of report                                      |
| -j         | --join-keys  | File(s) to be read (Pipe Separated for files, Comma separated for each column)     |
| -t         | --type | Save as the following formats: <CSV/csv/XLSX/xlsx>  |
| -m         | --merge | Merge two datasets: <inner/outer/left/right/append> |
| -p         | --pandas-profiling | Generate a pandas profiling report                  |
| -r         | --report | Generate a custom report with plots                 |


### Example:

Report and Pandas Profiling
```bash
report-manager --pandas-profiling --report
          --files "/home/Users/Fred/usa_weather.csv" 
          --name "USA Weather" 
          --type "XLSX" 
          --save-directory "/home/Users/Fred/Downloads"
```

Merge
```bash
report-manager --merge "append"
          --files "/home/Users/Fred/usa_weather.csv,/home/Users/Fred/mexico_weather.csv" 
          --name "North America Weather" 
          --type "csv" 
          --save-directory "/home/Users/Fred/Downloads" 
          --join-keys "column1,column2,column3"
```

#### Install Instructions
Install Python Package

```bash
python -m pip install report-manager
```

#### Build Instructions
Build Python Package

```bash
sudo chmod +x ./*.py
sudo pip install .
python setup.py bdist_wheel --universal
# Test Pypi
twine upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose -u "Username" -p "Password"
# Prod Pypi
twine upload dist/* --verbose -u "Username" -p "Password"
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Knuckles-Team/report-manager",
    "name": "report-manager",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Audel Rouhi",
    "author_email": "knucklessg1@gmail.com",
    "download_url": "",
    "platform": null,
    "description": "# Report Manager\n*Version: 0.7.0*\n\nManage your reports\n- Merge reports based off specified columns\n- Generate analysis on data set\n- Pandas profiling\n\n### Usage:\n| Short Flag | Long Flag | Description                                         |\n|------------| ------|-----------------------------------------------------|\n| -h         | --help | See Usage                                           |\n| -f         | --files | File(s) to be read (Comma separated)     |\n| -n         | --name | Name of report                                      |\n| -j         | --join-keys  | File(s) to be read (Pipe Separated for files, Comma separated for each column)     |\n| -t         | --type | Save as the following formats: <CSV/csv/XLSX/xlsx>  |\n| -m         | --merge | Merge two datasets: <inner/outer/left/right/append> |\n| -p         | --pandas-profiling | Generate a pandas profiling report                  |\n| -r         | --report | Generate a custom report with plots                 |\n\n\n### Example:\n\nReport and Pandas Profiling\n```bash\nreport-manager --pandas-profiling --report\n          --files \"/home/Users/Fred/usa_weather.csv\" \n          --name \"USA Weather\" \n          --type \"XLSX\" \n          --save-directory \"/home/Users/Fred/Downloads\"\n```\n\nMerge\n```bash\nreport-manager --merge \"append\"\n          --files \"/home/Users/Fred/usa_weather.csv,/home/Users/Fred/mexico_weather.csv\" \n          --name \"North America Weather\" \n          --type \"csv\" \n          --save-directory \"/home/Users/Fred/Downloads\" \n          --join-keys \"column1,column2,column3\"\n```\n\n#### Install Instructions\nInstall Python Package\n\n```bash\npython -m pip install report-manager\n```\n\n#### Build Instructions\nBuild Python Package\n\n```bash\nsudo chmod +x ./*.py\nsudo pip install .\npython setup.py bdist_wheel --universal\n# Test Pypi\ntwine upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose -u \"Username\" -p \"Password\"\n# Prod Pypi\ntwine upload dist/* --verbose -u \"Username\" -p \"Password\"\n```\n\n\n",
    "bugtrack_url": null,
    "license": "Unlicense",
    "summary": "Manage your reports",
    "version": "0.7.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "d6a7dd8ccfb7493ac0079532095dcbf0",
                "sha256": "371a7226b840ff030eed3da2b94b2357f37e1f34cdefc8e0f9c309d84490c7f9"
            },
            "downloads": -1,
            "filename": "report_manager-0.7.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d6a7dd8ccfb7493ac0079532095dcbf0",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 10806,
            "upload_time": "2022-12-23T19:03:45",
            "upload_time_iso_8601": "2022-12-23T19:03:45.458818Z",
            "url": "https://files.pythonhosted.org/packages/27/45/d60a5ca8cbb54aee139a0add91c9dd67749538fbd1b5b446e45f6813af65/report_manager-0.7.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-23 19:03:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "Knuckles-Team",
    "github_project": "report-manager",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "scikit-learn",
            "specs": [
                [
                    ">=",
                    "1.2.0"
                ]
            ]
        },
        {
            "name": "pandas",
            "specs": [
                [
                    ">=",
                    "1.5.2"
                ]
            ]
        },
        {
            "name": "matplotlib",
            "specs": [
                [
                    ">=",
                    "3.6.2"
                ]
            ]
        },
        {
            "name": "pandas_profiling",
            "specs": [
                [
                    ">=",
                    "3.6.0"
                ]
            ]
        },
        {
            "name": "scipy",
            "specs": [
                [
                    ">=",
                    "1.9.3"
                ]
            ]
        },
        {
            "name": "numpy",
            "specs": [
                [
                    ">=",
                    "1.23.5"
                ]
            ]
        },
        {
            "name": "xlsxwriter",
            "specs": [
                [
                    ">=",
                    "3.0.3"
                ]
            ]
        },
        {
            "name": "tabulate",
            "specs": [
                [
                    ">=",
                    "0.9.0"
                ]
            ]
        },
        {
            "name": "ipywidgets",
            "specs": [
                [
                    ">=",
                    "8.0.4"
                ]
            ]
        }
    ],
    "lcname": "report-manager"
}
        
Elapsed time: 0.08784s